influxdb3 install package
The influxdb3 install package command installs Python packages within the plugin environment for use in InfluxDB 3 Enterprise processing engine plugins.
Use this command to add external dependencies that your plugins require, such as data processing libraries, notification tools, or forecasting packages.
Usage
influxdb3 install package [OPTIONS] [PACKAGES]...Arguments
[PACKAGES]...: One or more package names to install (space-separated)
Options
| Option | Description | Default | Environment Variable |
|---|---|---|---|
-H, --host <HOST_URL> | The host URL of the running InfluxDB 3 Enterprise server | http://127.0.0.1:8181 | INFLUXDB3_HOST_URL |
--token <AUTH_TOKEN> | The token for authentication with the InfluxDB 3 Enterprise server | INFLUXDB3_AUTH_TOKEN | |
--plugin-dir <PLUGIN_DIR> | Location of the plugins directory | /plugins | INFLUXDB3_PLUGIN_DIR |
--virtual-env-location <VIRTUAL_ENV_LOCATION> | Custom virtual environment location | VIRTUAL_ENV | |
--package-manager <PACKAGE_MANAGER> | Package manager to use: discover, pip, uv, or disabled | discover | INFLUXDB3_PACKAGE_MANAGER |
--plugin-repo <PLUGIN_REPO> | Plugin repository URL | INFLUXDB3_PLUGIN_REPO | |
-r, --requirements <REQUIREMENTS> | Path to a requirements.txt file | ||
--tls-ca <CA_CERT> | Custom CA certificate for TLS (useful for self-signed certificates) | INFLUXDB3_TLS_CA | |
-h, --help | Print help information | ||
--help-all | Print detailed help information |
Examples
Install a single package
influxdb3 install package pandasInstall multiple packages
influxdb3 install package pint pandas requestsInstall packages from a requirements file
influxdb3 install package -r requirements.txtInstall packages with custom host and authentication
influxdb3 install package \
--host http://localhost:8181 \
--token AUTH_TOKEN \
pint pandasReplace the following:
AUTH_TOKEN: your admin token for your InfluxDB 3 Enterprise instance
Install packages with a specific package manager
influxdb3 install package \
--package-manager uv \
prophet adtkInstall packages with a custom CA certificate
influxdb3 install package \
--tls-ca /path/to/ca-cert.pem \
requestsPackage management
Package manager selection
By default (--package-manager discover), the CLI automatically detects and uses the best available package manager:
- uv (preferred): Faster package installation
- pip (fallback): Standard Python package manager
Virtual environment
The CLI manages a virtual environment for plugin packages to avoid conflicts with system Python packages.
You can customize the virtual environment location with --virtual-env-location or the VIRTUAL_ENV environment variable.
Security mode
If your InfluxDB 3 Enterprise server was started with --package-manager disabled, the influxdb3 install package command is blocked for security and compliance requirements.
When attempting to install packages with this command while the server has package installation disabled, the command fails with a 403 Forbidden error:
Package installation has been disabled. Contact your administrator for more information.The server’s --package-manager disabled setting is designed for:
- Enterprise security requirements: Prevent arbitrary package installation
- Compliance environments: Control exactly which packages are available
- Air-gapped deployments: Pre-install all dependencies before deployment
- Multi-tenant scenarios: Prevent tenants from installing potentially malicious packages
In these environments, administrators must pre-install all required Python packages into the server’s virtual environment before starting InfluxDB 3 Enterprise.
For more information, see the package-manager configuration option.
Troubleshooting
If package installation fails:
Check if package installation is disabled: If you receive a
403 Forbiddenerror, contact your administrator. Package installation may be disabled on your InfluxDB 3 Enterprise instance.Verify network connectivity: Ensure your InfluxDB 3 Enterprise instance can reach PyPI or your custom package repository
Check package names: Verify package names are correct and available in the package repository
Review logs: Check InfluxDB 3 Enterprise server logs for detailed error messages
Test with pip: Try installing the package directly with
pipto verify it’s availableUse requirements file: For complex dependencies, use a
requirements.txtfile with version pinningCheck Docker disk space (Docker environments only): If running InfluxDB 3 Enterprise in Docker and seeing “No space left on device” errors, free up disk space:
# Check Docker disk usage docker system df # Remove unused images and build cache docker image prune -af docker buildx prune -af
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.