2022-10-20 20:04:38 +00:00
|
|
|
# Install a plugin
|
|
|
|
|
|
|
|
Once you have [created your plugin](create.md), you can install it on your Funkwhale pod.
|
|
|
|
|
|
|
|
## Install a local plugin
|
|
|
|
|
|
|
|
To install a plugin located on your server:
|
|
|
|
|
|
|
|
1. Add the plugin directory to the `FUNKWHALE_PLUGINS_PATH` variable in your `.env` file
|
|
|
|
2. Add the plugin name to the `FUNKWHALE_PLUGINS` variable in your `.env` file
|
|
|
|
|
|
|
|
```{code-block} text
|
|
|
|
FUNKWHALE_PLUGINS=myplugin,anotherplugin
|
|
|
|
```
|
|
|
|
|
|
|
|
3. Restart Funkwhale to pick up the changes
|
|
|
|
|
|
|
|
## Install a third-party plugin
|
|
|
|
|
2023-01-13 15:33:23 +00:00
|
|
|
You can install third-party plugins using the `funkwhale-manage` command line interface. To do this:
|
2022-10-20 20:04:38 +00:00
|
|
|
|
|
|
|
1. Add the plugin name to the `FUNKWHALE_PLUGINS` variable in your `.env` file
|
|
|
|
|
|
|
|
```{code-block} text
|
|
|
|
FUNKWHALE_PLUGINS=myplugin,anotherplugin
|
|
|
|
```
|
|
|
|
|
2023-01-13 15:33:23 +00:00
|
|
|
2. Call the `funkwhale-manage` command line interface with the location of the plugin archive
|
2022-10-20 20:04:38 +00:00
|
|
|
|
|
|
|
:::: {tab-set}
|
|
|
|
|
|
|
|
:::{tab-item} Debian
|
|
|
|
|
|
|
|
```{code-block} shell
|
2023-01-13 15:33:23 +00:00
|
|
|
venv/bin/funkwhale-manage fw plugins install https://plugin_url.zip
|
2022-10-20 20:04:38 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
:::{tab-item} Docker
|
|
|
|
|
|
|
|
```{code-block} shell
|
2024-10-21 08:57:15 +00:00
|
|
|
docker compose run --rm api funkwhale-manage fw plugins install https://plugin_url.zip
|
2022-10-20 20:04:38 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
::::
|
|
|
|
|
|
|
|
3. Restart Funkwhale to pick up the changes
|