diff --git a/influxdb3-explorer/README-short.txt b/influxdb3-explorer/README-short.txt new file mode 100644 index 000000000000..62d9c83927dd --- /dev/null +++ b/influxdb3-explorer/README-short.txt @@ -0,0 +1 @@ +InfluxDB 3 Explorer is a web-based interface for querying and visualizing InfluxDB 3 data. \ No newline at end of file diff --git a/influxdb3-explorer/content.md b/influxdb3-explorer/content.md new file mode 100644 index 000000000000..5367f7c8c02f --- /dev/null +++ b/influxdb3-explorer/content.md @@ -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/) diff --git a/influxdb3-explorer/github-repo b/influxdb3-explorer/github-repo new file mode 100644 index 000000000000..8253c181ea5b --- /dev/null +++ b/influxdb3-explorer/github-repo @@ -0,0 +1 @@ +https://github.com/influxdata/influxdata-docker diff --git a/influxdb3-explorer/license.md b/influxdb3-explorer/license.md new file mode 100644 index 000000000000..00207f378fed --- /dev/null +++ b/influxdb3-explorer/license.md @@ -0,0 +1 @@ +View [license information](http://golang.org/LICENSE) for the software contained in this image. diff --git a/influxdb3-explorer/logo.png b/influxdb3-explorer/logo.png new file mode 100644 index 000000000000..814b2d78b596 Binary files /dev/null and b/influxdb3-explorer/logo.png differ diff --git a/influxdb3-explorer/maintainer.md b/influxdb3-explorer/maintainer.md new file mode 100644 index 000000000000..9a61d6230a28 --- /dev/null +++ b/influxdb3-explorer/maintainer.md @@ -0,0 +1 @@ +../.common-templates/maintainer-influxdata.md diff --git a/influxdb3-explorer/metadata.json b/influxdb3-explorer/metadata.json new file mode 100644 index 000000000000..56ca576ac81a --- /dev/null +++ b/influxdb3-explorer/metadata.json @@ -0,0 +1,9 @@ +{ + "hub": { + "categories": [ + "data-science", + "databases-and-storage", + "internet-of-things" + ] + } +}