update: start explorer docs

jts/explorer-docs
Peter Barnett 2025-05-29 01:36:08 -04:00
parent dc533920f1
commit 2c0c48f346
6 changed files with 94 additions and 1 deletions

View File

@ -8,6 +8,10 @@ menu:
chronograf_v1:
name: Chronograf v1.10
weight: 1
aliases:
- /explorer/
- /explorer/v1/
- /influxdb/v3/explorer/
---
Chronograf is InfluxData's open source web application.

View File

@ -0,0 +1,45 @@
---
title: InfluxDB 3 Explorer Documentation
description: >
InfluxDB 3 Explorer is a web-based interface for interacting with InfluxDB 3 Core and Enterprise. Visualize, query, and manage your time series data efficiently.
menu:
explorer_v1:
name: InfluxDB 3 Explorer
weight: 1
aliases:
- /explorer/
- /explorer/v3/
- /influxdb/v3/explorer/
---
InfluxDB 3 Explorer is a web application designed for visualizing, querying, and managing your InfluxDB 3 Core and Enterprise data. It provides an intuitive interface to easily interact with your time series data, simplifying operations and enhancing data insights.
## Overview
InfluxDB 3 Explorer enables users to explore and visualize data with a built-in visualizer, quickly write new data, and manage their databases and token setups.
## Key Features
### Database and Query Management
- Create and manage InfluxDB 3 databases
- Create and manage admin and resource tokens
- Configure new instance of InfluxDB 3 Enterprise
### Data Management
- Quickly query data with a built-in visualizer
- Write new data and setup new Telegraf configurations.
## Deployment with Docker
### Quick Start
Run InfluxDB 3 Explorer quickly with Docker:
```sh
docker run -d \
-p 8888:80 \
-p 8889:8888 \
explorer:latest \
--MODE=admin

View File

@ -0,0 +1,18 @@
---
title: About the InfluxDB 3 Explorer project
description: Learn about Explorer, the user interface and query tool for InfluxDB 3.
menu:
explorer_v1:
name: About the project
weight: 10
---
Explorer is the user interface compononent of the InfluxDB 3 platform. It makes visual management of databases and tokens straightforward, while also being an easy way to get started querying. It is fully featured for Core and Enterprise, while bringing query support for InfluxDB Cloud Serverless and InfluxDB Clustered.
## Third Party Software
InfluxData products contain third party software, which means the copyrighted, patented, or otherwise legally protected
software of third parties that is incorporated in InfluxData products.
Third party suppliers make no representation nor warranty with respect to such third party software or any portion thereof.
Third party suppliers assume no liability for any claim that might arise with respect to such third party software,
nor for a customers use of or inability to use the third party software.

View File

@ -0,0 +1,12 @@
---
title: Getting Started Guides for Explorer
description: Step-by-step instructions for using Explorer's features.
menu:
explorer_v1:
name: Getting Started
weight: 30
---
Follow the links below to get started using InfluxDB 3 Explorer.
{{< children >}}

View File

@ -0,0 +1,12 @@
---
title: Connect to a server
description:
Connecting to a server in InfluxDB 3 Explorer
menu:
explorer_v1:
name: Connect to a server
parent: Getting Started
weight: 10
---
This guide explains how to connect to a server in InfluxDB 3 Explorer, the first step to getting started with Explorer.

View File

@ -24,10 +24,11 @@ Identify products by their product path. Dictionary schema:
{{ $telegraf := dict "telegraf/v1" (slice "Telegraf" "telegraf") }}
{{ $chronograf := dict "chronograf/v1" (slice "Chronograf" "chronograf") }}
{{ $kapacitor := dict "kapacitor/v1" (slice "Kapacitor" "kapacitor") }}
{{ $explorer := dict "explorer/v3" (slice "Explorer" "explorer") }}
{{ $flux := dict "flux/v0" (slice "Flux" "flux") }}
{{ $enterpriseInfluxdb := dict "enterprise_influxdb/v1" (slice "InfluxDB Enterprise" "enterprise_v1") }}
{{ $productInfo := merge $influxdbOSSv1 $influxdbOSSv2 $influxdbCloud $influxdb3Core $influxdb3Enterprise $influxdb3CloudServerless $influxdb3CloudDedicated $influxdb3Clustered $telegraf $chronograf $kapacitor $flux $enterpriseInfluxdb }}
{{ $productInfo := merge $influxdbOSSv1 $influxdbOSSv2 $influxdbCloud $influxdb3Core $influxdb3Enterprise $influxdb3CloudServerless $influxdb3CloudDedicated $influxdb3Clustered $telegraf $chronograf $kapacitor $explorer $flux $enterpriseInfluxdb }}
{{ define "productLink" }}
{{ $defaultAltProductPage := $.context.GetPage ((replaceRE .pageRoot .productPath $.context.Page.RelPermalink) | replaceRE `\/$` "") }}
@ -80,6 +81,7 @@ Identify products by their product path. Dictionary schema:
<li>{{ template "productLink" (merge (dict "productPath" "telegraf/v1") $templateDefaults) }}</li>
<li>{{ template "productLink" (merge (dict "productPath" "chronograf/v1") $templateDefaults) }}</li>
<li>{{ template "productLink" (merge (dict "productPath" "kapacitor/v1") $templateDefaults) }}</li>
<li>{{ template "productLink" (merge (dict "productPath" "explorer/v3") $templateDefaults) }}</li>
</ul>
</div>
</div>