Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add InfluxDB 3 Explorer installation documentation (#6111) 

* InfluxDB 3 Explorer installation instructions

* fixed broken links

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* update: add getting started video

* updated to address PR feedback

* adjust page weights for explorer docs

* other minor updates

* more minor updates

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Peter Barnett <peter.barnett03@gmail.com>
pbarnett/explorer-docs
Scott Anderson 2025-05-29 18:20:09 -05:00 committed by GitHub
parent 55d820fbdd
commit 4370327b0d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 234 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
content/influxdb3/explorer/_index.md
View File

@ -6,10 +6,6 @@ menu:
influxdb3_explorer:
name: InfluxDB 3 Explorer
weight: 1
aliases:
- /explorer/
- /explorer/v3/
- /influxdb/v3/explorer/
---
InfluxDB 3 Explorer is the standalone web application designed for visualizing, querying, and managing your data stored in InfluxDB 3 Core and Enterprise.
@ -28,11 +24,13 @@ Use InfluxDB 3 Explorer for:
Run the Docker image to start InfluxDB 3 Explorer:
```sh
docker run -d \
-p 8888:80 \
-p 8889:8888 \
explorer:latest \
--MODE=admin
docker run --detach \
--name influxdb3-explorer \
--publish 8888:80 \
--publish 8889:8888 \
--env MODE=admin \
quay.io/influxdb/influxdb3-explorer:latest
```
[Get started with InfluxDB 3 Explorer](/explorer/v1/get-started/)
<a class="btn" href="/influxdb3/explorer/install/">Install and run InfluxDB 3 Explorer</a>
<a class="btn" href="/influxdb3/explorer/get-started/">Get started with InfluxDB 3 Explorer</a>

2
content/influxdb3/explorer/about/_index.md
View File

@ -5,7 +5,7 @@ description: >
menu:
influxdb3_explorer:
name: About Explorer
weight: 10
weight: 10
---
InfluxDB 3 Explorer is the user interface component of the InfluxDB 3 platform.

6
content/influxdb3/explorer/get-started/_index.md
View File

@ -4,9 +4,11 @@ description: Follow steps to get started using InfluxDB 3 Explorer.
menu:
influxdb3_explorer:
name: Get started
weight: 30
weight: 3
---
Follow steps to get started using InfluxDB 3 Explorer.
{{< page-nav next="/explorer/v1/get-started/connect/" >}}
{{< youtube "TbAz0AdaGH0" >}}
<!-- {{< page-nav next="/explorer/v1/get-started/connect/" >}} -->

3
content/influxdb3/explorer/get-started/connect.md
View File

@ -5,7 +5,8 @@ description:
menu:
influxdb3_explorer:
parent: Get started
weight: 10
weight: 101
draft: true
---
Use InfluxDB 3 Explorer to connect to an InfluxDB 3 server.

216
content/influxdb3/explorer/install.md Normal file
View File

@ -0,0 +1,216 @@
---
title: Install and run InfluxDB 3 Explorer
description: >
Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**.
menu:
influxdb3_explorer:
name: Install Explorer
weight: 2
---
Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**.
<!-- BEGIN TOC -->
- [Run the InfluxDB 3 Explorer Docker container](#run-the-influxdb-3-explorer-docker-container)
- [Enable TLS/SSL (HTTPS)](#enable-tlsssl-https)
- [Pre-configure InfluxDB connection settings](#pre-configure-influxdb-connection-settings)
- [Run in admin or query mode](#run-in-admin-or-query-mode)
- [Environment Variables](#environment-variables)
- [Volume Reference](#volume-reference)
- [Exposed Ports](#exposed-ports)
<!-- END TOC -->
## Run the InfluxDB 3 Explorer Docker container
1. **Install Docker**
If you haven't already, install [Docker](https://docs.docker.com/engine/) or
[Docker Desktop](https://docs.docker.com/desktop/).
2. **Pull the {{% product-name %}} Docker image**
```bash
docker pull quay.io/influxdb/influxdb3-explorer:latest
```
3. **Create local directories** _(optional)_
{{% product-name %}} can mount the following directories on your local
machine:
| Directory | Description | Permissions |
| :--------- | :------------------------------------------------------------------------------------------------ | :---------: |
| `./db` | Stores {{% product-name %}} application data | 700 |
| `./config` | Stores [pre-configured InfluxDB connection settings](#pre-configure-influxdb-connection-settings) | 755 |
| `./ssl` | Stores TLS/SSL certificates _(Required when [using TLS/SSL](#enable-tlsssl-https))_ | 755 |
> [!Important]
> If you don't create and mount a local `./db` directory, {{% product-name %}}
> stores application data in the container's file system.
> This data will be lost when the container is deleted.
To create these directories with the appropriate permissions, run the
following commands from your current working directory:
```bash
mkdir -m 700 ./db
mkdir -m 755 ./config
mkdir -m 755 ./ssl
```
4. **Run the {{% product-name %}} container**
Use the `docker run` command to start the {{% product-name %}} container.
Include the following:
- Port mappings:
- `8888` to `80` (or `443` if using TLS/SSL)
- `8889` to `8888`
- Mounted volumes:
- `$(pwd)/db:/db:rw`
- `$(pwd)/config:/app-root/config:ro`
- `$(pwd)/ssl:/etc/nginx/ssl:ro`
- Any of the available [environment variables](#environment-variables)
```bash
docker run --detach \
--name influxdb3-explorer \
--publish 8888:80 \
--publish 8889:8888 \
--volume $(pwd)/config:/app-root/config:ro \
--volume $(pwd)/db:/db:rw \
--volume $(pwd)/ssl:/etc/nginx/ssl:ro \
--env MODE=admin \
quay.io/influxdb/influxdb3-explorer:latest
```
5. **Access the {{% product-name %}} user interface (UI) at <http://localhost:8888>**.
---
## Enable TLS/SSL (HTTPS)
To enable TLS/SSL, mount valid certificate and key files into the container:
1. **Place your TLS/SSL certificate files your local `./ssl` directory**
Required files:
- Certificate: `server.crt` or `fullchain.pem`
- Private key: `server.key`
2. **When running your container, mount the SSL directory and map port 443 to port 8888**
Include the following options when running your Docker container:
```sh
--volume $(pwd)/ssl:/etc/nginx/ssl:ro \
--publish 8888:443
```
The nginx web server automatically uses certificate files when they are present
in the mounted path.
---
## Pre-configure InfluxDB connection settings
You can predefine InfluxDB connection settings using a `config.json` file.
{{% code-placeholders "INFLUXDB3_HOST|INFLUXDB_DATABASE_NAME|INFLUXDB3_AUTH_TOKEN|INFLUXDB3_SERVER_NAME" %}}
1. **Create a `config.json` file in your local `./config` directory**
```json
{
"DEFAULT_INFLUX_SERVER": "INFLUXDB3_HOST",
"DEFAULT_INFLUX_DATABASE": "INFLUXDB_DATABASE_NAME",
"DEFAULT_API_TOKEN": "INFLUXDB3_AUTH_TOKEN",
"DEFAULT_SERVER_NAME": "INFLUXDB3_SERVER_NAME"
}
```
> [!Important]
> If connecting to an InfluxDB 3 Core or Enterprise instance running on
> localhost (outside of the container), use the internal Docker network to
> in your InfluxDB 3 host value--for example:
>
> ```txt
> http://host.docker.internal:8181
> ```
2. **Mount the configuration directory**
Include the following option when running your Docker container:
```sh
--volume $(pwd)/config:/app-root/config:ro
```
{{% /code-placeholders %}}
These settings will be used as defaults when the container starts.
---
## Run in query or admin mode
{{% product-name %}} has the following operational modes:
- **Query mode (default):** Read-only UI and query interface
- **Admin mode:** Full UI and API access for administrators
You can control the operational mode using the `MODE` environment variable.
### Run in query mode {note="(default)"}
```sh
docker run -d \
-e MODE=query \
...
```
### Run in admin mode
```sh
docker run -d \
-e MODE=admin \
...
```
If `MODE` is not set, the container defaults to query mode.
---
## Environment Variables
| Variable | Description | Default |
|----------------|--------------------------------------------------|----------------------|
| `DATABASE_URL` | Path to SQLite DB inside container | `/db/sqlite.db` |
| `MODE` | Set to `admin` or `query` | `query` |
---
## Volume Reference
| Container Path | Purpose | Host Example |
|----------------------|------------------------------|----------------------------|
| `/db` | SQLite DB storage | `./db` |
| `/app-root/config` | JSON config for defaults | `./config` |
| `/etc/nginx/ssl` | SSL certs for HTTPS | `./ssl` |
---
## Exposed Ports
| Port | Protocol | Purpose |
|------|----------|-------------------------|
| 80 | HTTP | Web access (unencrypted) |
| 443 | HTTPS | Web access (encrypted) |
### Custom port mapping
```sh
# Map ports to custom host values
-p 8888:80 -p 8443:443
```

BIN
cypress/downloads/downloads.html Normal file
View File

Binary file not shown.

2
layouts/partials/article/beta.html
View File

@ -10,7 +10,7 @@
{{ if in $earlyAccessList (print $product "/" $version )}}
<div class="block beta">
<div class="beta-content">
<h4>{{ $displayName }} is in Public Beta</h4>
<h4 id="public-beta">{{ $displayName }} is in Public Beta</h4>
<p>
{{ $displayName }} is in public beta and available for testing and feedback,
but is <strong>not meant for production use yet</strong>.

2
layouts/shortcodes/product-name.html
View File

@ -11,6 +11,8 @@
{{- $scratch.Set "productData" .Site.Data.products.influxdb3_core -}}
{{- else if eq $currentProduct "enterprise" -}}
{{- $scratch.Set "productData" .Site.Data.products.influxdb3_enterprise -}}
{{- else if eq $currentProduct "explorer" -}}
{{- $scratch.Set "productData" .Site.Data.products.influxdb3_explorer -}}
{{- else if eq $currentProduct "cloud-serverless" -}}
{{- $scratch.Set "productData" .Site.Data.products.influxdb3_cloud_serverless -}}
{{- else if eq $currentProduct "cloud-dedicated" -}}