added basic options for users to add plugins #50

Author: pSpitzner

CHANGELOG.md

@@ -9,9 +9,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+-  Option to install beets plugins by placing either `requirements.txt` or `startup.sh` in /`config`. cf. [Readthedocs](https://beets-flask.readthedocs.io/en/latest/plugins.html)
+-  [Documentation](https://beets-flask.readthedocs.io/en/latest/?badge=latest) on readthedocs.
 -  Option to import Asis via right-click, or as inbox type. Good for Bootlegs that do not
    have online meta data and you curate manually. Currently also applies `--group-albums`.
 
+### Fixed
+
+-  Path escaping for right-click import via cli (#51)
+
 ## [0.1.0] - 24-11-13
 
 ### Fixed

Dockerfile

@@ -102,7 +102,15 @@ COPY --from=deps /repo /repo
 COPY --from=build /repo/frontend/dist /repo/frontend/dist
 COPY entrypoint.sh .
 COPY entrypoint_fix_permissions.sh .
+COPY entrypoint_user_scripts.sh .
 RUN chown -R beetle:beetle /repo
 
 USER root
-ENTRYPOINT ["/bin/sh", "-c", "./entrypoint_fix_permissions.sh && su beetle -c ./entrypoint.sh"]
+
+ENTRYPOINT [ \
+    "/bin/sh", "-c", \
+    "/repo/entrypoint_fix_permissions.sh && \
+    /repo/entrypoint_user_scripts.sh && \
+    su beetle -c /repo/entrypoint.sh" \
+]
+

docs/index.md

@@ -21,12 +21,13 @@ hide-toc: true
 This documentation is very much a work in progress. If you have any questions or suggestions, please feel free to open an issue or a pull request.
 ```
 
-```{toctree}    
+```{toctree}
 ---
 maxdepth: 1
 ---
 
 contribution
 developer
+plugins
 ```
 

docs/plugins.md

@@ -0,0 +1,66 @@
+# Installing beets plugins
+
+```{warning}
+We have not tested a lot of plugins with beets-flask gui.
+Plugin support is experimental.
+```
+
+Installing beets plugins varies depending on the particular plugin.
+[See the official docs](https://docs.beets.io/en/latest/plugins/index.html).
+
+We might automate this in the future, but for now you can place either a `requirements.txt` or `startup.sh` in the `/config` folder.
+After starting, the container will run the startup script if it exists, and afterwards install the requirements from the `requirements.txt` file using pip.
+
+
+## Example startup.sh: keyfinder
+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.
+
+Place the following in a `startup.sh` file in the `/config` folder.
+
+```sh
+#!/bin/sh
+
+apk update
+apk add \
+    build-base \
+    ffmpeg-dev \
+    libkeyfinder-dev \
+
+git clone https://github.com/evanpurkhiser/keyfinder-cli.git
+cd keyfinder-cli/
+make
+make install
+```
+Note that the container is based on alpine, so you have to use apk.
+Make executable
+```sh
+chmod +x ./startup.sh
+```
+
+
+Edit beets `config.yaml` to include the plugin.
+```yaml
+plugins:
+    [
+        keyfinder,
+    ]
+
+keyfinder:
+    auto: yes
+    bin: /usr/local/bin/keyfinder-cli
+    overwrite: no
+```
+
+Note, in case you want to use another key format, you have to create an alias of the executable and specify that in the `config.yaml`.
+Also, your container start-up time might increase considerably.
+
+
+## Example requirements.txt: discogs
+
+Place the following in a `requirements.txt` file in the `/config` folder.
+
+```txt
+beets[discogs]
+```
+
+and follow the instructions in the [official docs](https://docs.beets.io/en/latest/plugins/discogs.html).

entrypoint_user_scripts.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# check for user startup scripts
+if [ -f /config/startup.sh ]; then
+    echo "Running user startup script"
+    /config/startup.sh
+fi
+
+# check for requirements.txt
+if [ -f /config/requirements.txt ]; then
+    echo "Installing pip requirements"
+    pip install -r /config/requirements.txt
+fi