diff --git a/README.md b/README.md index 6436260..cacf618 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,26 @@ The architectures supported by this image are: | arm64 | ✅ | arm64v8-\ | | armhf | ❌ | | +## Application Setup + +Edit the config file in /config + +To edit the config from within the container use `beet config -e` + +For a command prompt as user abc `docker exec -it -u abc beets bash` + +See [Beets](http://beets.io/) for more info. + +Contains [beets-extrafiles](https://github.com/Holzhaus/beets-extrafiles) plugin, [configuration details](https://github.com/Holzhaus/beets-extrafiles#usage) + +## Read-Only Operation + +This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/). + +## Non-Root Operation + +This image can be run with a non-root user. For details please [read the docs](https://docs.linuxserver.io/misc/non-root/). + ## Usage To help you get started creating a container from this image you can either use docker-compose or the docker cli. @@ -279,7 +299,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions -* **28.08.24:** - Rebase to Alpine 3.21, unpin beetcamp. +* **27.01.25:** - Rebase to Alpine 3.21, unpin beetcamp. * **22.10.24:** - Pin beetcamp to 0.19.2 until upstream requirements fixed. * **01.10.24:** - Add packages required for Discogs plugin. * **28.08.24:** - Rebase to Alpine 3.20. diff --git a/readme-vars.yml b/readme-vars.yml index 1ff3bad..657bbd3 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -23,6 +23,18 @@ param_ports: - {external_port: "8337", internal_port: "8337", port_desc: "Application WebUI"} readonly_supported: true nonroot_supported: true +# application setup block +app_setup_block_enabled: true +app_setup_block: | + Edit the config file in /config + + To edit the config from within the container use `beet config -e` + + For a command prompt as user abc `docker exec -it -u abc beets bash` + + See [Beets](http://beets.io/) for more info. + + Contains [beets-extrafiles](https://github.com/Holzhaus/beets-extrafiles) plugin, [configuration details](https://github.com/Holzhaus/beets-extrafiles#usage) # init diagram init_diagram: | "beets:nightly": { @@ -67,7 +79,7 @@ init_diagram: | "beets:nightly" <- Base Images # changelog changelogs: - - {date: "28.08.24:", desc: "Rebase to Alpine 3.21, unpin beetcamp."} + - {date: "27.01.25:", desc: "Rebase to Alpine 3.21, unpin beetcamp."} - {date: "22.10.24:", desc: "Pin beetcamp to 0.19.2 until upstream requirements fixed."} - {date: "01.10.24:", desc: "Add packages required for Discogs plugin."} - {date: "28.08.24:", desc: "Rebase to Alpine 3.20."}