Manage your InfluxDB 3 Enterprise license
InfluxDB 3 Enterprise licenses authorize the use of the InfluxDB 3 Enterprise software and apply to a single cluster. Licenses are primarily based on the number of CPUs InfluxDB can use, but there are other limitations depending on the license type.
- License feature comparison
- CPU limit
- Upgrade from InfluxDB 3 Core
- Activate a license
- Change your license type
- Renew a license
- Expiration behavior
License feature comparison
The following InfluxDB 3 Enterprise license types are available:
- Trial: 30-day trial license with full access to InfluxDB 3 Enterprise capabilities.
- At-Home: For at-home hobbyist use with limited access to InfluxDB 3 Enterprise capabilities.
- Commercial: Commercial license with full access to InfluxDB 3 Enterprise capabilities.
| Features | Trial | At-Home | Commercial |
|---|---|---|---|
| CPU Core Limit | 256 | 2 | Per contract |
| Expiration | 30 days | Never | Per contract |
| Multi-node | |||
| Commercial use |
All other InfluxDB 3 Enterprise features are available to all licenses.
CPU limit
Each InfluxDB 3 Enterprise license limits the number of CPUs InfluxDB can use. The CPU limit is per cluster, not per machine. A cluster may consist of multiple nodes that share the available CPU limit.
For example, you can purchase a 32-CPU Commercial license and set up an InfluxDB 3 Enterprise cluster with the following:
- 3 × writer nodes, each with 4 CPUs (12 total)
- 1 × compactor node with 8 CPUs
- 3 × query nodes, each with 4 CPUs (12 total)
With the InfluxDB 3 Enterprise Commercial license, CPU cores are purchased in batches of 8, 16, 32, 64, or 128 cores.
CPU accounting
CPU cores are determined by whatever the operating system of the host machine reports as its core count. InfluxDB 3 Enterprise does not differentiate between physical and virtual CPU cores.
If using Linux, InfluxDB uses whatever cgroup CPU accounting is active–for
example: cpuset or cpu.shares.
Upgrade from InfluxDB 3 Core
To upgrade from InfluxDB 3 Core to InfluxDB 3 Enterprise, see Upgrade from Core.
Activate a license
Each InfluxDB 3 Enterprise license must be activated when you start the server, but the process of activating the license depends on the license type:
Activate a trial or at-home license
- Use the
influxdb3 servecommand to start the server. If the server doesn’t find a license file or email address, the server prompts you to enter your email address. If you’re activating an InfluxDB trial or home license with Docker or with DEB/RPM installs, include options to skip the email prompt. - The server prompts you to select a license type. Select
trialorhome. - In the verification email from InfluxDB 3 Enterprise, click the button to verify your email address.
After you verify your email address, InfluxDB 3 Enterprise auto-generates a license (associated with your cluster and email address) and stores the license file in your object store. The license file is a JWT file that contains the license information.
Activate a trial or home license with Docker or Linux packaging
If you’re starting a new InfluxDB 3 Enterprise server in a Docker container or installed via DEB or RPM, you must use one of the methods to skip the email prompt. This ensures that the server can generate the license file after you verify your email address. See the following examples:
Skip the email prompt
To skip the email prompt when starting the server, you can provide your email address using one of the following methods:
- CLI option: Use the
--license-emailoption with theinfluxdb3 servecommand - Environment variable: Set the
INFLUXDB3_ENTERPRISE_LICENSE_EMAILenvironment variable - TOML config (DEB/RPM-only): Set the
license-emailoption in the/etc/influxdb3/influxdb3-enterprise.conffile for a DEB or RPM install
If the server finds a valid license file in your object store, it ignores the license email option.
See examples to start the server with your license email.
Use an existing trial or at-home license
When you activate a trial or at-home license, InfluxDB registers your email address with the license server. To use your existing license–for example, if you deleted your license file–provide your email address using one of the following methods:
- CLI option: Use the
--license-emailoption with theinfluxdb3 servecommand - Environment variable: Set the
INFLUXDB3_ENTERPRISE_LICENSE_EMAILenvironment variable - TOML config (DEB/RPM-only): Set the
license-emailoption in the/etc/influxdb3/influxdb3-enterprise.conffile for a DEB or RPM install
InfluxDB validates your email address with the license server and uses your existing license if it’s still valid.
Activate a commercial license
Contact InfluxData Sales to obtain an InfluxDB 3 Enterprise Commercial license. Provide the following:
- Cluster UUID
- Object Store Info
This information is provided in the output of the InfluxDB 3 Enterprise server if you try to start the server without a valid license.
InfluxData will provide you with a commercial license file. The license file is a JWT file that contains the license information.
When starting the InfluxDB 3 Enterprise server, provide the license file path using one of the following methods:
- CLI option: Use the
--license-fileoption with theinfluxdb3 servecommand - Environment variable: Set the
INFLUXDB3_ENTERPRISE_LICENSE_FILEenvironment variable. - TOML config (DEB/RPM-only): Set the
license-fileoption in the/etc/influxdb3/influxdb3-enterprise.conffile for a DEB or RPM install
- CLI option: Use the
License detection
InfluxDB 3 Enterprise checks for a license in the following order:
--license-fileCLI option orlicense-fileTOML optionINFLUXDB3_ENTERPRISE_LICENSE_FILEenvironment variable- Default commercial license path in the object store
- Default trial/home license path in the object store
--license-emailCLI option orlicense-emailTOML optionINFLUXDB3_ENTERPRISE_LICENSE_EMAILenvironment variable- If no license is found, the server won’t start
Default license file location
When using the default license path (items 3-4 above), InfluxDB 3 Enterprise looks for the license file in your object store directory:
<OBJECT_STORE>/<CLUSTER_ID>/commercial_license
<OBJECT_STORE>/<CLUSTER_ID>/trial_or_home_licenseStart the server with your license email
The following examples show how to provide your license email for different InfluxDB 3 Enterprise installation methods:
influxdb3 serve \
--cluster-id CLUSTER_ID \
--node-id NODE_ID \
--license-email EMAIL_ADDRESS \
# ...INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=EMAIL_ADDRESS
influxdb3 serve \
--cluster-id CLUSTER_ID \
--node-id NODE_ID \
# ...# compose.yaml
name: data-crunching-stack
services:
influxdb3-enterprise:
container_name: influxdb3-enterprise
image: influxdb:3-enterprise
ports:
- 8181:8181
command:
- influxdb3
- serve
- --node-id=NODE_ID
- --cluster-id=CLUSTER_ID
- --object-store=file
- --data-dir=/var/lib/influxdb3/data
- --plugin-dir=/var/lib/influxdb3/plugins
environment:
- INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=EMAIL_ADDRESS
volumes:
- type: bind
# Path to store data on your host system
source: ~/.influxdb3/data
# Path to store data in the container
target: /var/lib/influxdb3/data
- type: bind
# Path to store plugins on your host system
source: ~/.influxdb3/plugins
# Path to store plugins in the container
target: /var/lib/influxdb3/pluginsReplace the following:
EMAIL_ADDRESS: Your email address for license activationNODE_ID: Your existing node identifier from CoreCLUSTER_ID: A new cluster identifier for Enterprise~/.influxdb3/data: The same data directory you used with Core~/.influxdb3/plugins: The same plugins directory you used with Core
Edit
/etc/influxdb3/influxdb3-enterprise.confto add your license email:license-email="EMAIL_ADDRESS"To start the server, run the following command:
# systemd (modern systems; see logs with 'journalctl --unit influxdb3-enterprise') systemctl start influxdb3-enterprise # SysV init (legacy systems; logs to /var/lib/influxdb3/influxdb3-enterprise.log) /etc/init.d/influxdb3-enterprise start
Start the server with your license file
The following examples show how to provide your license file for different InfluxDB 3 Enterprise installation methods:
influxdb3 serve \
--cluster-id cluster01 \
--node-id node01 \
--license-file /path/to/license-file.jwt \
# ...INFLUXDB3_ENTERPRISE_LICENSE_FILE=/path/to/license-file.jwt
influxdb3 serve \
--cluster-id cluster01 \
--node-id node01 \
# ...Edit
/etc/influxdb3/influxdb3-enterprise.confto add your license file path:license-file="/etc/influxdb3/license-file.jwt"Ensure the license file has strict permissions that allow the database to read the file:
chown root:influxdb3 /etc/influxdb3/influxdb3-enterprise.conf chmod 0640 /etc/influxdb3/influxdb3-enterprise.confTo start the server, run the following command:
# systemd (modern systems; see logs with 'journalctl --unit influxdb3-enterprise') systemctl start influxdb3-enterprise # SysV init (legacy systems; logs to /var/lib/influxdb3/influxdb3-enterprise.log) /etc/init.d/influxdb3-enterprise start
For more information about influxdb3 serve options, see the
CLI reference.
Change your license type
If you need to change your InfluxDB 3 Enterprise license type–for example, from Trial to At-Home, or from Trial to Commercial–follow these steps.
Identify your current license
Check your current license type and status:
influxdb3 show license --host http://localhost:8181Change from Trial or At-Home to a different Trial or At-Home license
To switch between Trial and At-Home licenses (or to reset a Trial license), you need to remove the existing license file so the server prompts you to select a new license type.
Stop the server (press Ctrl+C or
pkill -f "influxdb3 serve").Back up and remove the existing license file from your data directory (the path you passed to
--data-dir). The license file is stored at:<DATA_DIR>/<CLUSTER_ID>/trial_or_home_licenseFor example, if your data directory is
~/.influxdb3/dataand cluster ID iscluster0:# Back up the license file mv~/.influxdb3/data/cluster0/trial_or_home_license \~/.influxdb3/data/cluster0/trial_or_home_license.bakRestart the server with your license email:
influxdb3 serve \ --license-emailEMAIL_ADDRESS\ # ... other optionsReplace
EMAIL_ADDRESSwith your email address for license activation.Select the new license type when prompted (or the server automatically activates the license associated with your email).
Verify your email by clicking the link in the verification email.
Verify the new license:
influxdb3 show license --host http://localhost:8181
Stop the container:
docker stop influxdb3-enterpriseBack up and remove the existing license file from your data volume. The license file is stored in the host path mounted to your data volume:
<HOST_DATA_PATH>/<CLUSTER_ID>/trial_or_home_licenseFor example, if your compose file mounts
~/.influxdb3/datato/var/lib/influxdb3/dataand your cluster ID iscluster0:# Back up the license file on the host mv~/.influxdb3/data/cluster0/trial_or_home_license \~/.influxdb3/data/cluster0/trial_or_home_license.bakRestart the container with your license email:
docker run -d \ -e INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=EMAIL_ADDRESS\ # ... other options influxdb:3-enterpriseReplace
EMAIL_ADDRESSwith your email address for license activation.Check your email and click the verification link to activate the license.
Verify the new license:
influxdb3 show license --host http://localhost:8181
Stop the server:
sudo systemctl stop influxdb3-enterpriseBack up and remove the existing license file from the default data directory. The license file is stored at:
/var/lib/influxdb3/data/<CLUSTER_ID>/trial_or_home_licenseFor DEB/RPM installs using the default
primary-clustercluster ID:# Back up the license file sudo mv /var/lib/influxdb3/data/primary-cluster/trial_or_home_license \ /var/lib/influxdb3/data/primary-cluster/trial_or_home_license.bakUpdate the license email in your configuration file:
Edit
/etc/influxdb3/influxdb3-enterprise.conf:license-email = "new-email@example.com"Restart the server:
sudo systemctl start influxdb3-enterpriseCheck your email and click the verification link to activate the license.
Verify the new license:
influxdb3 show license --host http://localhost:8181
Change to a Commercial license
To upgrade to a Commercial license from any other license type:
Contact InfluxData Sales to obtain a Commercial license file. Provide:
- Your cluster ID
- Your object store information
Stop the server.
Start the server with the commercial license file.
The commercial license takes precedence over any existing trial or at-home license in your object store.
Start the server with the --license-file option:
influxdb3 serve \
--license-file /path/to/commercial-license.jwt \
# ... other optionsOr set the environment variable:
export INFLUXDB3_ENTERPRISE_LICENSE_FILE=/path/to/commercial-license.jwt
influxdb3 serve # ... other optionsVerify the new license:
influxdb3 show license --host http://localhost:8181Mount the license file and set the environment variable:
docker run -d \
-v /path/to/commercial-license.jwt:/license.jwt:ro \
-e INFLUXDB3_ENTERPRISE_LICENSE_FILE=/license.jwt \
# ... other options
influxdb:3-enterpriseVerify the new license:
influxdb3 show license --host http://localhost:8181Copy the license file to the server:
sudo cp/path/to/commercial-license.jwt/etc/influxdb3/license.jwt sudo chown influxdb3:influxdb3 /etc/influxdb3/license.jwt sudo chmod 600 /etc/influxdb3/license.jwtUpdate the configuration to use the license file:
Edit
/etc/influxdb3/influxdb3-enterprise.conf:license-file = "/etc/influxdb3/license.jwt"Start the server:
sudo systemctl start influxdb3-enterpriseVerify the new license:
influxdb3 show license --host http://localhost:8181
Renew a license
To renew an InfluxDB 3 Enterprise Commercial license, contact InfluxData Sales.
Expiration behavior
When your InfluxDB 3 Enterprise license expires, the following occurs:
- Write requests continue to be accepted and processed.
- Compactions continue to optimize persisted data.
- Query requests return an error.
- If the InfluxDB 3 Enterprise server stops, it will not restart without a valid, non-expired license.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB 3 Enterprise and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support. Customers using a trial license can email trial@influxdata.com for assistance.