Skip to content

Commit 8dd0aad

Browse files
committed
Small additions to the plugins guide in the docs see #50
1 parent 5dd43a6 commit 8dd0aad

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/plugins.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ Plugin support is experimental.
88
Installing beets plugins varies depending on the particular plugin.
99
[See the official docs](https://docs.beets.io/en/latest/plugins/index.html).
1010

11-
We might automate this in the future, but for now you can place either a `requirements.txt` or `startup.sh` in the `/config` folder.
12-
After starting, the container will run the startup script if it exists, and afterwards install the requirements from the `requirements.txt` file using pip.
11+
We might automate this in the future, but for now you can place a `requirements.txt` and/or `startup.sh` in the `/config` folder. The `requirements.txt` may include [python dependencies](https://pip.pypa.io/en/stable/reference/requirements-file-format/), and the `startup.sh` file may be an executable shell script that is compatible with the container's alpine linux base.
1312

13+
On startup, the container will run the startup script if it exists, and afterwards install the requirements from the `requirements.txt` file using pip.
1414

1515
## Example startup.sh: keyfinder
16+
1617
For example, we can install the [keyfinder plugin](https://docs.beets.io/en/latest/plugins/keyfinder.html) via `startup.sh`, as it requires quite a few build steps.
1718

1819
Place the following in a `startup.sh` file in the `/config` folder.

0 commit comments

Comments
 (0)