Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion content/influxdb3/enterprise/admin/explorer-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ The integrated Explorer keeps its application state in a SQLite database that
the server synchronizes to object storage for each cluster.
You don't mount a volume to persist it, which is the main operational
difference from the
[Explorer Docker container](/influxdb3/explorer/install/#persist-data-across-restarts).
[Explorer Docker container](/influxdb3/explorer/install/docker/#persist-data-across-restarts).

## Migrate data from the 3.11 UI {#migrate-data-from-the-311-ui metadata="v3.12+"}

Expand Down
2 changes: 1 addition & 1 deletion content/influxdb3/enterprise/visualize-data/explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ works with v3.11 and later.
Use the container when you run Core, when you run an Enterprise release
earlier than v3.11, or when you want Explorer to run separately from the
database server--for example, on an operator workstation.
See [Install and run InfluxDB 3 Explorer](/influxdb3/explorer/install/).
See [Install and run InfluxDB 3 Explorer with Docker](/influxdb3/explorer/install/docker/).
48 changes: 32 additions & 16 deletions content/influxdb3/explorer/_index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
---
title: InfluxDB 3 Explorer documentation
description: >
InfluxDB 3 Explorer is a standalone web-based interface for interacting with InfluxDB 3 Core and Enterprise. Visualize, query, and manage your time series data efficiently.
InfluxDB 3 Explorer is a web-based interface for InfluxDB 3 Core and Enterprise. Visualize, query, and manage your time series data efficiently.
menu:
influxdb3_explorer:
name: InfluxDB 3 Explorer
weight: 1
cascade:
product: influxdb3_explorer
version: explorer
prepend: |
> [!Important]
> #### How you install Explorer depends on your InfluxDB 3 server
>
> Starting with InfluxDB 3 Enterprise v3.11, Explorer is included with
> the server and runs as WebAssembly (WASM)--there's no separate
> container to install. Docker is required for InfluxDB 3 Core and
> Enterprise earlier than v3.11, and remains an option for later
> Enterprise releases. See
> [Install Explorer](/influxdb3/explorer/install/) to find the
> instructions for your server.
---

InfluxDB 3 Explorer is the standalone web application designed for visualizing, querying, and managing your data stored in InfluxDB 3 Core and Enterprise.
InfluxDB 3 Explorer is the web application for visualizing, querying, and managing your data stored in InfluxDB 3 Core and Enterprise.
Explorer provides an intuitive interface for interacting with your time series data, streamlining database operations and enhancing data insights.

## Key features
Expand All @@ -24,23 +35,28 @@ Use InfluxDB 3 Explorer for:

## Quick start

Run the Docker image to start InfluxDB 3 Explorer:
How you install {{% product-name %}} depends on your InfluxDB 3 server:

```sh
# Pull the Docker image
docker pull influxdata/influxdb3-ui
- **InfluxDB 3 Enterprise v3.11 and later** includes Explorer as an
integrated WASM component. See
[Use the integrated Explorer UI](/influxdb3/enterprise/admin/explorer-ui/).
- **InfluxDB 3 Core and Enterprise** can run Explorer as a standalone Docker
container. Docker is required for Core and Enterprise earlier than v3.11:

# Run the Docker container
docker run --detach \
--name influxdb3-explorer \
--publish 8080:8080 \
--publish 8443:8443 \
influxdata/influxdb3-ui \
--mode=admin
```sh
# Pull the Docker image
docker pull influxdata/influxdb3-ui

# Visit http://localhost:8080 in your browser to begin using InfluxDB 3 Explorer
```
# Run the Docker container
docker run --detach \
--name influxdb3-explorer \
--publish 8080:8080 \
--publish 8443:8443 \
influxdata/influxdb3-ui \
--mode=admin

# Visit http://localhost:8080 in your browser to begin using InfluxDB 3 Explorer
```

For installation and configuration options, see [Install and run InfluxDB 3 Explorer](/influxdb3/explorer/install/).
For installation and configuration options, see [Install InfluxDB 3 Explorer](/influxdb3/explorer/install/).
<a class="btn" href="/influxdb3/explorer/get-started/">Get started using InfluxDB 3 Explorer</a>
7 changes: 7 additions & 0 deletions content/influxdb3/explorer/about/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ Explorer is fully featured for [InfluxDB 3 Core](/influxdb3/core/) and
[InfluxDB 3 Enterprise](/influxdb3/enterprise/).
You can use Explorer to query data in and administer these products.

Explorer runs as a standalone Docker container that works with either Core or
Enterprise. Starting with InfluxDB 3 Enterprise v3.11, Explorer is also
available as an integrated WebAssembly (WASM) component of the Enterprise
server; it isn't distributed this way for Core. See
[Install Explorer](/influxdb3/explorer/install/) to find the instructions for
your InfluxDB 3 server.

Explorer provides only _partial_ support for
[InfluxDB Cloud Dedicated](/influxdb3/cloud-dedicated/) and
[InfluxDB Cloud Serverless](/influxdb3/cloud-serverless/).
Expand Down
21 changes: 16 additions & 5 deletions content/influxdb3/explorer/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,10 @@ InfluxDB 3 Explorer supports the following InfluxDB 3 products:
> For Linux Docker Engine details, see the [Docker daemon documentation](https://docs.docker.com/reference/cli/dockerd/#configure-host-gateway-ip).

- **Token**: The authorization token to use to connect to your InfluxDB 3 server.
We recommend using an InfluxDB 3 _admin_ token.
A resource token is enough to query and write data within the permissions
you grant it.
To manage databases, tokens, and other resources from Explorer, use an
admin token.

> [!Important]
> #### Token permissions determine Explorer's access
Expand All @@ -83,10 +86,18 @@ InfluxDB 3 Explorer supports the following InfluxDB 3 products:
> tokens with limited permissions may not be able to use some Explorer
> functionality.
>
> The token's permissions also define what anyone with access to this
> Explorer instance can do. Use a token scoped to what you need, and
> control who can reach Explorer. See
> [Network exposure and access control](/influxdb3/explorer/install/#network-exposure-and-access-control).
> Without user authentication, the token's permissions also define what
> anyone with access to this Explorer instance can do. Use a token scoped
> to what you need, and control who can reach Explorer.
> With user authentication on an InfluxDB 3 Enterprise v3.12 or later
> server, users sign in first and their role determines what they can do.
> If you're running the
> [Docker container](/influxdb3/explorer/install/docker/), see
> [Network exposure and access control](/influxdb3/explorer/install/docker/#network-exposure-and-access-control).
> If you're using the
> [integrated Explorer UI](/influxdb3/enterprise/admin/explorer-ui/),
> control access through
> [`--http-bind`](/influxdb3/enterprise/reference/config-options/#http-bind).

4. Click **Add Server**.

Expand Down
52 changes: 52 additions & 0 deletions content/influxdb3/explorer/install/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Install InfluxDB 3 Explorer
description: >
Install and run InfluxDB 3 Explorer. Instructions depend on your InfluxDB 3
server--integrated WASM for InfluxDB 3 Enterprise v3.11 and later, or
Docker for InfluxDB 3 Core and Enterprise.
menu:
influxdb3_explorer:
name: Install Explorer
weight: 2
alt_links:
enterprise: /influxdb3/enterprise/admin/explorer-ui/
related:
- /influxdb3/enterprise/admin/explorer-ui/, Use the integrated Explorer UI
---

How you install {{% product-name %}} depends on the InfluxDB 3 server you're
connecting it to:

- **InfluxDB 3 Enterprise v3.11 and later** includes Explorer as an
integrated WebAssembly (WASM) component--there's no separate container to
install. For setup instructions, see
[Use the integrated Explorer UI](/influxdb3/enterprise/admin/explorer-ui/).
- **InfluxDB 3 Core and Enterprise** can run Explorer as a standalone Docker
container. Docker is required for Core and Enterprise earlier than v3.11.
For installation and configuration instructions, see
[Install and run InfluxDB 3 Explorer with Docker](/influxdb3/explorer/install/docker/).

## Check which version applies to you

If you already have an InfluxDB 3 server running, check its version and
edition with `GET /ping`:

```sh
curl --get "http://localhost:8181/ping" \
--header "Authorization: Bearer AUTH_TOKEN"
```

The response includes the following version details:

- `x-influxdb-version` reports the InfluxDB 3 server version.
- `x-influxdb-build` reports whether the server is Core or Enterprise.
- The response body includes the version in its `version` field.

Use `GET`; a `HEAD` request to `/ping` returns `404`.

If `x-influxdb-build` reports `Enterprise` and `x-influxdb-version` is `3.11`
or later, use the
[integrated Explorer UI](/influxdb3/enterprise/admin/explorer-ui/).
Otherwise, use [Docker](/influxdb3/explorer/install/docker/).
Docker also works with Enterprise v3.11 and later if you want to run Explorer
separately from the server.
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
---
title: Install and run InfluxDB 3 Explorer
title: Install and run InfluxDB 3 Explorer with Docker
description: >
Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**.
Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**
as a standalone container against InfluxDB 3 Core or Enterprise.
menu:
influxdb3_explorer:
name: Install Explorer
weight: 2
name: Docker
weight: 1
metadata: [InfluxDB 3 Core and Enterprise]
---

Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**.
Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**
as a standalone container with [InfluxDB 3 Core](/influxdb3/core/) or
[InfluxDB 3 Enterprise](/influxdb3/enterprise/), including Enterprise v3.11
and later.
Starting with Enterprise v3.11, Explorer is also available as an integrated
WebAssembly (WASM) component of the server. See
[Use the integrated Explorer UI](/influxdb3/enterprise/admin/explorer-ui/)
if you run Enterprise v3.11 or later and don't need a separate container.

> [!Important]
> #### Control who can reach Explorer
Expand Down Expand Up @@ -232,8 +241,8 @@ Use the following practices to control access:

{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Docker](#)
[Docker Compose](#)
[Run container](#)
[Compose](#)
{{% /code-tabs %}}

{{% code-tab-content %}}
Expand Down Expand Up @@ -350,8 +359,8 @@ Instead of configuring connections through the UI, you can pre-define connection

{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Docker](#)
[Docker Compose](#)
[Run container](#)
[Compose](#)
{{% /code-tabs %}}

{{% code-tab-content %}}
Expand Down Expand Up @@ -405,8 +414,8 @@ To enable TLS/SSL for secure connections:

{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Docker](#)
[Docker Compose](#)
[Run container](#)
[Compose](#)
{{% /code-tabs %}}

{{% code-tab-content %}}
Expand Down Expand Up @@ -481,12 +490,12 @@ To configure Explorer to trust self-signed or custom CA certificates when connec
3. **Mount the CA certificate directory and set the `NODE_EXTRA_CA_CERTS` environment variable:**

{{< expand-wrapper >}}
{{% expand "View example Docker configuration for self-signed certificates" %}}
{{% expand "View example configuration for self-signed certificates" %}}

{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Docker](#)
[Docker Compose](#)
[Run container](#)
[Compose](#)
{{% /code-tabs %}}
{{% code-tab-content %}}

Expand Down Expand Up @@ -548,8 +557,8 @@ Set the mode using the `--mode` parameter:

{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Docker](#)
[Docker Compose](#)
[Run container](#)
[Compose](#)
{{% /code-tabs %}}

{{% code-tab-content %}}
Expand Down Expand Up @@ -635,8 +644,8 @@ services:

{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Docker](#)
[Docker Compose](#)
[Run container](#)
[Compose](#)
{{% /code-tabs %}}

{{% code-tab-content %}}
Expand Down
7 changes: 5 additions & 2 deletions content/influxdb3/explorer/manage-databases.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@

> [!Important]
> Using {{% product-name %}} to manage a database in InfluxDB 3 requires that
> Explorer is running in [admin mode](/influxdb3/explorer/install/#choose-operational-mode)
> and that the token used in the InfluxDB 3 server configuration is an
> the token used in the InfluxDB 3 server configuration is an
> [admin token](/influxdb3/enterprise/admin/tokens/admin/).
> If you're running the
> [Docker container](/influxdb3/explorer/install/docker/), Explorer must also
> be running in
> [admin mode](/influxdb3/explorer/install/docker/#choose-operational-mode).

To manage databases, navigate to **Manage Databases** in Explorer.
This page provides a list of databases in the connected InfluxDB 3 server that
Expand All @@ -44,7 +47,7 @@

4. Click **{{< icon "check" >}} Create Database**.

## Delete a database

Check warning on line 50 in content/influxdb3/explorer/manage-databases.md

View workflow job for this annotation

GitHub Actions / Vale style check

InfluxDataDocs.Capitalization

'Delete a database' should be in sentence case

1. On the **Manage Databases** page, click **{{< icon "trash" >}}**.
2. Confirm that you want to delete the database.
Expand Down
9 changes: 6 additions & 3 deletions content/influxdb3/explorer/manage-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,13 @@ related:
Core instance or InfluxDB 3 Enterprise cluster.

> [!Important]
> Using {{% product-name %}} to manage authorization tokens in InfluxDB 3 requires that
> Explorer is running in [admin mode](/influxdb3/explorer/install/#choose-operational-mode)
> and that the token used in the InfluxDB 3 server configuration is an
> Using {{% product-name %}} to manage authorization tokens in InfluxDB 3
> requires that the token used in the InfluxDB 3 server configuration is an
> [admin token](/influxdb3/enterprise/admin/tokens/admin/).
> If you're running the
> [Docker container](/influxdb3/explorer/install/docker/), Explorer must also
> be running in
> [admin mode](/influxdb3/explorer/install/docker/#choose-operational-mode).

To manage InfluxDB authorization tokens, navigate to **Manage Tokens** in Explorer.
This page provides a list of databases in the connected InfluxDB 3 server that
Expand Down
Loading
Loading