readme-vars.yml

---

# project information
project_name: beets
project_url: "http://beets.io/"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/beets-icon.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is a music library manager and not, for the most part, a music player. It does include a simple player plugin and an experimental Web-based player, but it generally leaves actual sound-reproduction to specialized tools."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_categories: "Music"
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# development version
development_versions: true
development_versions_items:
  - {tag: "latest", desc: "Stable Beets Releases"}
  - {tag: "nightly", desc: "Built against head of Beets git, generally considered unstable but a likely choice for power users of the application."}
# container parameters
common_param_env_vars_enabled: true #PGID, PUID, etc, you can set it to 'optional'
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"}
  - {vol_path: "/music", vol_host_path: "/path/to/music/library", desc: "Music library"}
  - {vol_path: "/downloads", vol_host_path: "/path/to/ingest", desc: "Non processed music"}
param_usage_include_ports: true
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:latest": {
    docker-mods
    base {
      fix-attr +\nlegacy cont-init
    }
    docker-mods -> base
    legacy-services
    custom services
    init-services -> legacy-services
    init-services -> custom services
    custom services -> legacy-services
    legacy-services -> ci-service-check
    init-migrations -> init-adduser
    init-config -> init-beets-config
    init-os-end -> init-config
    init-config -> init-config-end
    init-crontab-config -> init-config-end
    init-config -> init-crontab-config
    init-mods-end -> init-custom-files
    base -> init-envfile
    base -> init-migrations
    init-config-end -> init-mods
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-custom-files -> init-services
    init-services -> svc-beets
    svc-beets -> legacy-services
    init-services -> svc-cron
    svc-cron -> legacy-services
  }
  Base Images: {
    "baseimage-alpine:3.21"
  }
  "beets:latest" <- Base Images
# changelog
changelogs:
  - {date: "27.01.25:", desc: "Rebase to Alpine 3.21."}
  - {date: "01.10.24:", desc: "Add packages required for Discogs plugin."}
  - {date: "28.08.24:", desc: "Rebase to Alpine 3.20, switch from Pillow to Imagemagick."}
  - {date: "23.12.23:", desc: "Rebase to Alpine 3.19."}
  - {date: "25.08.23:", desc: "Rebase to Alpine 3.18, pin Pillow to 9.5.0."}
  - {date: "07.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
  - {date: "25.03.23:", desc: "Add requests_oauthlib required for [beatport plugin](https://beets.readthedocs.io/en/stable/plugins/beatport.html)."}
  - {date: "24.02.23:", desc: "Rebase to Alpine 3.17, migrate to s6v3, install chromaprint from Alpine repos, add beetcamp plugin."}
  - {date: "15.01.22:", desc: "Rebasing to alpine 3.15."}
  - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
  - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
  - {date: "12.05.19:", desc: "Add flac and mp3val binaries required for badfiles plugin."}
  - {date: "12.04.19:", desc: "Rebase to Alpine 3.9."}
  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
  - {date: "11.03.19:", desc: "Swap copyartifacts for extrafiles, update endpoints with nightly tag."}
  - {date: "01.03.19:", desc: "Switch to python3."}
  - {date: "07.02.19:", desc: "Add fftw-dev build dependency for chromaprint."}
  - {date: "28.01.19:", desc: "Add pipeline logic and multi arch."}
  - {date: "15.08.18:", desc: "Rebase to alpine 3.8, use alpine repo version of pylast."}
  - {date: "12.08.18:", desc: "Add requests pip package."}
  - {date: "04.03.18:", desc: "Upgrade mp3gain to 1.6.1."}
  - {date: "02.01.18:", desc: "Deprecate cpu_core routine lack of scaling."}
  - {date: "27.12.17:", desc: "Add beautifulsoup4 pip package."}
  - {date: "06.12.17:", desc: "Rebase to alpine linux 3.7."}
  - {date: "25.05.17:", desc: "Rebase to alpine linux 3.6."}
  - {date: "06.02.17:", desc: "Rebase to alpine linux 3.5."}
  - {date: "16.01.17:", desc: "Add packages required for replaygain."}
  - {date: "24.12.16:", desc: "Add [beets-copyartifacts](https://github.com/sbarakat/beets-copyartifacts) plugin."}
  - {date: "07.12.16:", desc: "Edit cmake options for chromaprint, should now build and install fpcalc, add gstreamer lib"}
  - {date: "14.10.16:", desc: "Add version layer information."}
  - {date: "01.10.16:", desc: "Add nano and editor variable to allow editing of the config from the container command line."}
  - {date: "30.09.16:", desc: "Fix umask."}
  - {date: "24.09.16:", desc: "Rebase to alpine linux."}
  - {date: "10.09.16:", desc: "Add layer badges to README."}
  - {date: "05.01.16:", desc: "Change ffpmeg repository, other version crashes container"}
  - {date: "06.11.15:", desc: "Initial Release"}
  - {date: "29.11.15:", desc: "Take out term setting, causing issues with key entry for some users"}