Skip to content

Creating InfluxDB 3 Explorer Docker Image #2598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
71e1aaa
Add initial influxdb3-explorer documentation structure
MeelahMe Jul 15, 2025
f087e25
docs: add GitHub repo URL to github-repo file
MeelahMe Jul 15, 2025
1638f49
docs: add short description to README-short.txt
MeelahMe Jul 15, 2025
0e616f7
docs: Add short message for license.md
MeelahMe Jul 15, 2025
aaee7d7
docs: Add short description for maintainer.md
MeelahMe Jul 15, 2025
7f3df53
docs: Add metedata for explorer
MeelahMe Jul 15, 2025
8300e30
docs: add intro and quick start section to README
MeelahMe Jul 15, 2025
91df866
docs: updates to README content
MeelahMe Jul 15, 2025
7338a5a
docs: update to metedata.md
MeelahMe Jul 16, 2025
5539830
small update to github-repo.md
MeelahMe Jul 16, 2025
5f5637e
small update to metadata.md
MeelahMe Jul 16, 2025
2b9af04
docs: minor update to files to fix CI issue
MeelahMe Jul 16, 2025
5ea2c83
minor update to metadata.json format
MeelahMe Jul 16, 2025
3458694
Adding a logo file
MeelahMe Jul 16, 2025
b39590f
small update to metadata.json
MeelahMe Jul 16, 2025
a1ccbc0
minor update to metadata.json
MeelahMe Jul 17, 2025
f92fc31
minor update to metadata.json
MeelahMe Jul 17, 2025
077882f
Update influxdb3-explorer/content.md
MeelahMe Jul 17, 2025
6504b06
Update influxdb3-explorer/content.md
MeelahMe Jul 17, 2025
6e9a724
Update influxdb3-explorer/content.md
MeelahMe Jul 17, 2025
69905be
Update influxdb3-explorer/content.md
MeelahMe Jul 17, 2025
1e71874
CI: removing extra newline for CI
MeelahMe Jul 17, 2025
6d6a9fc
docs: Clarifying docker pull and image name in examples
MeelahMe Jul 17, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions influxdb3-explorer/README-short.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
InfluxDB 3 Explorer is a web-based interface for querying and visualizing InfluxDB 3 data.
148 changes: 148 additions & 0 deletions influxdb3-explorer/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
# What is InfluxDB 3 Explorer?

InfluxDB 3 Explorer is a standalone web application designed for visualizing, querying, and managing your data stored in InfluxDB 3. Explorer provides an intuitive interface for interacting with your time series data.

%%LOGO%%

# How to use this image

## Requirements

To use InfluxDB 3 Explorer, you need a compatible InfluxDB 3 instance, such as InfluxDB 3 Core or InfluxDB 3 Enterprise. See the official [InfluxDB Docker image](https://hub.docker.com/_/influxdb).

## Pull the image

```bash
docker pull influxdata/influxdb3-ui:1.0.0
```

## Start InfluxDB 3 Explorer

Run InfluxDB 3 Explorer using Docker CLI.

### Query mode (default)

To start Explorer in query mode for read-only access:

```bash
docker run --detach \
--name influxdb3-explorer \
--publish 8888:80 \
influxdata/influxdb3-ui:1.0.0
```

### Admin mode

To start Explorer in admin mode with full functionality:

```bash
docker run --detach \
--name influxdb3-explorer \
--publish 8888:80 \
--publish 8889:8888 \
influxdata/influxdb3-ui:1.0.0 \
--mode=admin
```

This command:

- Maps container port `80` to host port `8888` (web UI)
- Maps container port `8888` to host port `8889` (API access)
- Runs the container in admin mode

If `--mode` is not set, the container defaults to query mode.

Access the Explorer UI at `http://localhost:8888` in your browser.

## Persistent data storage

To preserve Explorer application data across container restarts, mount a local directory:

```bash
mkdir -m 700 ./db
```

```bash
docker run --detach \
--name influxdb3-explorer \
--publish 8888:80 \
--volume $(pwd)/db:/db:rw \
influxdata/influxdb3-ui:1.0.0 \
--mode=admin
```

## Pre-configure InfluxDB connections

To pre-configure InfluxDB connection settings, create a `config.json` file and mount it:

```bash
mkdir -m 755 ./config

{
"DEFAULT_INFLUX_SERVER": "http://host.docker.internal:8181",
"DEFAULT_INFLUX_DATABASE": "my_database",
"DEFAULT_API_TOKEN": "your-admin-token",
"DEFAULT_SERVER_NAME": "my_server"
}
```

```bash
docker run --detach \
--name influxdb3-explorer \
--publish 8888:80 \
--volume $(pwd)/config:/app-root/config:ro \
--volume $(pwd)/db:/db:rw \
influxdata/influxdb3-ui:1.0.0 \
--mode=admin
```

## Enable HTTPS

To enable TLS/SSL, mount valid certificate and key files into the container:

Place your TLS/SSL certificate files in your local `./ssl` directory: Required files:

Certificate: `server.crt` or `fullchain.pem` Private key: `server.key`

```bash
mkdir -m 755 ./ssl

# Place your server.crt and server.key files in ./ssl directory

docker run --detach \
--name influxdb3-explorer \
--publish 8888:443 \
--volume $(pwd)/ssl:/etc/nginx/ssl:ro \
influxdata/influxdb3-ui:1.0.0 \
--mode=admin
```

The nginx web server automatically uses certificate files when they are present in the mounted path.

## Custom SSL certificate paths

You can use custom locations for certificate and key files:

```bash
docker run --detach \
--name influxdb3-explorer \
--publish 8888:443 \
--volume $(pwd)/ssl:/custom/ssl:ro \
--env SSL_CERT_PATH=/custom/ssl/server.crt \
--env SSL_KEY_PATH=/custom/ssl/server.key \
influxdata/influxdb3-ui:1.0.0 \
--mode=admin
```

## Environment variables

The following environment variables can be used to configure the container:

- `DATABASE_URL` - Path to SQLite database inside container (default: `/db/sqlite.db`)
- `SESSION_SECRET_KEY` - Secret key for session management (recommended for production)
- `SSL_CERT_PATH` - Path to SSL certificate file (default: `/etc/nginx/ssl/cert.pem`)
- `SSL_KEY_PATH` - Path to SSL private key file (default: `/etc/nginx/ssl/key.pem`)

**Important for production:** Always set `SESSION_SECRET_KEY` in production. When you restart the container, InfluxDB 3 Explorer generates a new key if not explicitly set.

For more information about available options and environment variables, see the [InfluxDB 3 Explorer documentation](https://docs.influxdata.com/influxdb3/explorer/install/)
1 change: 1 addition & 0 deletions influxdb3-explorer/github-repo
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://github.com/influxdata/influxdata-docker
1 change: 1 addition & 0 deletions influxdb3-explorer/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
View [license information](http://golang.org/LICENSE) for the software contained in this image.
Binary file added influxdb3-explorer/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions influxdb3-explorer/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../.common-templates/maintainer-influxdata.md
9 changes: 9 additions & 0 deletions influxdb3-explorer/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"hub": {
"categories": [
"data-science",
"databases-and-storage",
"internet-of-things"
]
}
}