From 2e047fbe8d9744f56294a82ad4941f99a451da95 Mon Sep 17 00:00:00 2001 From: aptalca Date: Mon, 1 Mar 2021 13:09:21 -0500 Subject: [PATCH] update readme with app setup info --- README.md | 12 ++++++++++++ readme-vars.yml | 13 +++++++++++++ 2 files changed, 25 insertions(+) diff --git a/README.md b/README.md index e37c8f5..2cbf308 100644 --- a/README.md +++ b/README.md @@ -156,6 +156,18 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel   +## 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-copyartifacts](https://github.com/sbarakat/beets-copyartifacts) plugin, [configuration details](https://github.com/sbarakat/beets-copyartifacts#configuration) + ## Docker Mods [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=beets&query=%24.mods%5B%27beets%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=beets "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") diff --git a/readme-vars.yml b/readme-vars.yml index 15900ba..91ed56d 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -37,6 +37,19 @@ param_usage_include_ports: true param_ports: - { external_port: "8337", internal_port: "8337", port_desc: "Application WebUI" } +# 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-copyartifacts](https://github.com/sbarakat/beets-copyartifacts) plugin, [configuration details](https://github.com/sbarakat/beets-copyartifacts#configuration) + # changelog changelogs: - { date: "19.12.19:", desc: "Rebasing to alpine 3.11." }