Skip to content

Commit 6433bc9

Browse files
committed
docs(setup): add InfluxDB 3 Enterprise licensing steps with Docker example
1 parent b03af14 commit 6433bc9

File tree

1 file changed

+60
-6
lines changed
  • content/shared/influxdb3-get-started

1 file changed

+60
-6
lines changed

content/shared/influxdb3-get-started/setup.md

Lines changed: 60 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -350,17 +350,71 @@ influxdb3 serve --help
350350
{{% show-in "enterprise" %}}
351351
## Set up licensing
352352

353-
When first starting a new instance, {{% product-name %}} prompts you to select a
354-
license type. InfluxDB 3 Enterprise licenses authorize the use of the
355-
InfluxDB 3 Enterprise software and apply to a single cluster. Licenses are
356-
primarily based on the number of CPUs InfluxDB can use, but there are other
357-
limitations depending on the license type. The following InfluxDB 3 Enterprise
358-
license types are available:
353+
When starting a new {{% product-name %}} instance, you must provide a **valid license key** to enable Enterprise features such as clustering, plugin support, and multi-user authorization.
354+
355+
InfluxDB 3 Enterprise licenses:
356+
357+
- **Authorize** usage of InfluxDB 3 Enterprise software.
358+
- **Apply per cluster**, with limits based primarily on CPU cores.
359+
- **Vary by license type**, each offering different capabilities and restrictions.
360+
361+
### Available license types:
359362

360363
- **Trial**: 30-day trial license with full access to InfluxDB 3 Enterprise capabilities.
361364
- **At-Home**: For at-home hobbyist use with limited access to InfluxDB 3 Enterprise capabilities.
362365
- **Commercial**: Commercial license with full access to InfluxDB 3 Enterprise capabilities.
363366

367+
You can obtain a license key from the [InfluxData pricing page](https://www.influxdata.com/pricing/).
368+
369+
### Start InfluxDB 3 Enterprise with your license
370+
371+
To start InfluxDB 3 Enterprise in a Docker container, set the `INFLUX_LICENSE_KEY` environment variable:
372+
373+
{{% code-placeholders "YOUR_LICENSE_KEY" %}}
374+
375+
```bash
376+
docker run -d --name influxdb3-enterprise \
377+
-v $PWD/data:/var/lib/influxdb3 \
378+
-v $PWD/plugins:/plugins \
379+
-p 8086:8086 \
380+
-e INFLUX_LICENSE_KEY=YOUR_LICENSE_KEY \
381+
influxdb:enterprise \
382+
serve \
383+
--cluster-id cluster1 \
384+
--node-id node1 \
385+
--plugin-dir /plugins \
386+
--object-store file \
387+
--data-dir /var/lib/influxdb3
388+
```
389+
390+
{{% /code-placeholders %}}
391+
392+
- Replace `YOUR_LICENSE_KEY` with your actual InfluxDB 3 Enterprise license key.
393+
394+
Once the Docker container is running, create an admin token to authenticate requests:
395+
396+
{{% code-placeholders "YOUR_LICENSE_KEY" %}}
397+
398+
```bash
399+
docker exec -it influxdb3-enterprise influxdb3 create token --admin
400+
```
401+
402+
{{% /code-placeholders %}}
403+
404+
Use the token to create a database:
405+
406+
{{% code-placeholders "YOUR_AUTH_TOKEN" %}}
407+
408+
```bash
409+
docker exec -it influxdb3-enterprise \
410+
influxdb3 create database example_db --token YOUR_AUTH_TOKEN
411+
```
412+
413+
{{% /code-placeholders %}}
414+
415+
> [!Note]
416+
> A valid license is required to use `create token` and other authorization features in {{% product-name %}}.
417+
364418
For more information, see [Manage your InfluxDB 3 Enterprise license](/influxdb3/enterprise/admin/license/).
365419
{{% /show-in %}}
366420

0 commit comments

Comments
 (0)