fix(influxdb3): add python directory requirement note to plugins setup

pull/6465/head
meelahme 2025-10-16 12:02:37 -07:00
parent 3b6988e12f
commit eef29546d7
2 changed files with 17 additions and 0 deletions

View File

@ -48,6 +48,9 @@ when starting the {{% product-name %}} server.
`PLUGIN_DIR` is your file system location for storing [plugin](#plugin) files for
the processing engine to run.
> [!Note]
> If you manually installed from tar.gz, ensure the `influxdb3` binary and `python/` directory remain in the same parent location. The install script handles this automatically.
{{% code-placeholders "PLUGIN_DIR" %}}
<!-- pytest.mark.skip -->
```bash

View File

@ -34,6 +34,20 @@ Once you have all the prerequisites in place, follow these steps to implement th
To activate the Processing Engine, start your {{% product-name %}} server with the `--plugin-dir` flag. This flag tells InfluxDB where to load your plugin files.
> [!Important]
> #### Keep influxdb3 and python/ together
>
> The influxdb3 binary requires the adjacent `python/` directory to function.
> If you manually extract from tar.gz, keep them in the same parent directory:
>
> {{< filesystem-diagram >}}
> - your-install-location/
> - influxdb3
> - python/
> {{< /filesystem-diagram >}}
>
> Add the directory (not just the binary) to your PATH. Moving only the binary will cause Python runtime errors.
{{% code-placeholders "NODE_ID|OBJECT_STORE_TYPE|PLUGIN_DIR" %}}
```bash