docker-library/docs

Undocumented InfluxDB macro's INFLUXD_TLS_CERT and INFLUXD_TLS_KEY

Erriez opened this issue · 3 comments

Erriez commented

Macro's INFLUXD_TLS_CERT and INFLUXD_TLS_KEY are missing in README.md to enable SSL.

docker-compose.yml example:

version: '3'

services:
  influxdb:
    image: influxdb:2.4.0
    container_name: influxdb
    restart: always
    ports:
      - 8086:8086
    environment:
      - DOCKER_INFLUXDB_INIT_MODE=setup
      - DOCKER_INFLUXDB_INIT_USERNAME=${NFLUXDB_USERNAME}
      - DOCKER_INFLUXDB_INIT_PASSWORD=${NFLUXDB_PASSWORD}
      - DOCKER_INFLUXDB_INIT_ORG=${INFLUXDB_ORG}
      - DOCKER_INFLUXDB_INIT_BUCKET=${INFLUXDB_BUCKET}
      - DOCKER_INFLUXDB_INIT_ADMIN_TOKEN=${INFLUXDB_ADMIN}
      - INFLUXD_TLS_CERT=/ssl/finluxd.crt
      - INFLUXD_TLS_KEY=/ssl/finluxd.key
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - ${VOLUME_DIR}/influxdb2/data:/var/lib/influxdb2
      - ${VOLUME_DIR}/ssl:/ssl:ro
tianon commented

cc influxdb image maintainers: @bnpfeife @jeffreyssmith2nd

jeffreyssmith2nd commented

Sorry if I've missed something, new to maintaining docker images. These options are documented here. They are not specific to the Docker image and are just options to Influxdb itself. Do they actually need to be documented in the Docker docs?

tianon commented

Ah, that makes sense -- it's up to each maintainer what they want to include, but we do typically encourage the documentation to stick to things that are either specific to the Dockerization or that the way you use them changes significantly due to running in Docker, which this doesn't sound like really fits either. 👍

  • 👍1