docker-documentation/images/docker-beets.md

linuxserver/beets

Beets 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.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here.

Simply pulling linuxserver/beets should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Tag
x86-64	amd64-latest
arm64	arm64v8-latest
armhf	arm32v6-latest

Usage

Here are some example snippets to help you get started creating a container from this image.

docker

docker create \
  --name=beets \
  -e PUID=1001 \
  -e PGID=1001 \
  -e TZ=Europe/London \
  -p 8337:8337 \
  -v </path/to/appdata/config>:/config \
  -v </path/to/music/library>:/music \
  -v </path/to/ingest>:/downloads \
  --restart unless-stopped \
  linuxserver/beets

docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2"
services:
  beets:
    image: linuxserver/beets
    container_name: beets
    environment:
      - PUID=1001
      - PGID=1001
      - TZ=Europe/London
    volumes:
      - </path/to/appdata/config>:/config
      - </path/to/music/library>:/music
      - </path/to/ingest>:/downloads
    ports:
      - 8337:8337
    mem_limit: 4096m
    restart: unless-stopped

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter	Function
8337	Application WebUI

Environment Variables (-e)

Env	Function
PUID=1001	for UserID - see below for explanation
PGID=1001	for GroupID - see below for explanation
TZ=Europe/London	Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume	Function
/config	Configuration files.
/music	Music library
/downloads	Non processed music

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1001 and PGID=1001, to find yours use id user as below:

  $ id username
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

Support Info

• Shell access whilst the container is running:
  • docker exec -it beets /bin/bash
• To monitor the logs of the container in realtime:
  • docker logs -f beets
• Container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' beets
• Image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/beets

Versions

• 07.02.19: - Add fftw-dev build dependency for chromaprint.
• 28.01.19: - Add pipeline logic and multi arch.
• 15.08.18: - Rebase to alpine 3.8, use alpine repo version of pylast.
• 12.08.18: - Add requests pip package.
• 04.03.18: - Upgrade mp3gain to 1.6.1.
• 02.01.18: - Deprecate cpu_core routine lack of scaling.
• 27.12.17: - Add beautifulsoup4 pip package.
• 06.12.17: - Rebase to alpine linux 3.7.
• 25.05.17: - Rebase to alpine linux 3.6.
• 06.02.17: - Rebase to alpine linux 3.5.
• 16.01.17: - Add packages required for replaygain.
• 24.12.16: - Add beets-copyartifacts plugin.
• 07.12.16: - Edit cmake options for chromaprint, should now build and install fpcalc, add gstreamer lib
• 14.10.16: - Add version layer information.
• 01.10.16: - Add nano and editor variable to allow editing of the config from the container command line.
• 30.09.16: - Fix umask.
• 24.09.16: - Rebase to alpine linux.
• 10.09.16: - Add layer badges to README.
• 05.01.16: - Change ffpmeg repository, other version crashes container
• 06.11.15: - Initial Release
• 29.11.15: - Take out term setting, causing issues with key entry for some users