influxdata / influxdata/docs-v2
InfluxDB 3 Explorer documentation corrections
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
Hi all,
I have been testing InfluxDB3 Explorer recently and stumbled on a couple of issues.
1. SSL Configuration.
I wanted to include certificates and followed the outlined procedure in the published documentation.
The documentation is not correct in several areas of the certificates implementation. One is the location and naming of the certificates, the second exposing ports.
I solved the first issue by inspecting the "entrypoint.sh" in the container. I found that it expects two variables present SSL_CERT_PATH and SSL_KEY_PATH. This not documented.
Also in your example you expose port 8888:443. This is not correct.
Also note that because there is a symlink creation the SSL folder needs to be RW!!
The correct working configured command line starting the container should therefore be:
```
docker run --detach \
--name influxdb3-explorer-tessie01 \
--publish 443:443 \
--publish 8889:8888 \
--env SSL_CERT_PATH=/etc/nginx/ssl/eddysys-nl-fullchain.crt \
--env SSL_KEY_PATH=/etc/nginx/ssl/eddysys-nl.key \
--volume $(pwd)/config:/app-root/config:ro \
--volume $(pwd)/db:/db:rw \
--volume $(pwd)/ssl:/etc/nginx/ssl:rw \
quay.io/influxdb/influxdb3-explorer:latest \
--mode=admin
```
2. Config file
The config.json file is NOT picked up during the start of the container.
I have tried:
```
{
"DEFAULT_INFLUX_SERVER": "http://192.168.30.170:8181",
"DEFAULT_INFLUX_DATABASE": "victron-mqtt",
"DEFAULT_API_TOKEN": "apiv3_SDNiuG9613F865OJB--77NgWIKSR3QrnJ2N_F2wH6NTbNkTrSj8EsEp9HwPitvNwj5EkWB6a-NO1Cl9ugTcBfg",
"DEFAULT_SERVER_NAME": "inlfuxdb3-01"
}
```
And
```
{
"DEFAULT_INFLUX_SERVER": "http://host.docker.internal:8181",
"DEFAULT_INFLUX_DATABASE": "victron-mqtt",
"DEFAULT_API_TOKEN": "apiv3_SDNiuG9613F865OJB--77NgWIKSR3QrnJ2N_F2wH6NTbNkTrSj8EsEp9HwPitvNwj5EkWB6a-NO1Cl9ugTcBfg",
"DEFAULT_SERVER_NAME": "inlfuxdb3-01"
}
```
##### Relevant URLs
- https://docs.influxdata.com/influxdb3/explorer/
Hope this helps!!
Best,
Edward Voermans, edward.voermans@me.com
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the InfluxDB 3 Explorer documentation at the linked URL and inspect the container's entrypoint.sh, which the report identifies as the source of the SSL variables and paths. Reproduce the documented Docker setup and test the config.json behavior. Done means the SSL paths, port mappings, volume permissions, environment variables, and configuration-file behavior are accurately documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100