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¶

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/beets:latest 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	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Version Tags¶

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag	Available	Description
latest	✅	Stable Beets Releases
nightly	✅	Built against head of Beets git, generally considered unstable but a likely choice for power users of the application.

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 for more info.

Contains beets-extrafiles plugin, configuration details

Read-Only Operation¶

This image can be run with a read-only container filesystem. For details please read the docs.

Non-Root Operation¶

This image can be run with a non-root user. For details please read the docs.

Usage¶

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

Info

Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)¶

---
services:
  beets:
    image: lscr.io/linuxserver/beets:latest
    container_name: beets
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/beets/config:/config
      - /path/to/music/library:/music
      - /path/to/ingest:/downloads
    ports:
      - 8337:8337
    restart: unless-stopped

docker cli (click here for more info)¶

docker run -d \
  --name=beets \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 8337:8337 \
  -v /path/to/beets/config:/config \
  -v /path/to/music/library:/music \
  -v /path/to/ingest:/downloads \
  --restart unless-stopped \
  lscr.io/linuxserver/beets:latest

Parameters¶

Containers 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:8337`	Application WebUI

Environment Variables (`-e`)¶

Env	Function
`PUID=1000`	for UserID - see below for explanation
`PGID=1000`	for GroupID - see below for explanation
`TZ=Etc/UTC`	specify a timezone to use, see this list.

Volume Mappings (`-v`)¶

Volume	Function
`/config`	Persistent config files
`/music`	Music library
`/downloads`	Non processed music

Miscellaneous Options¶

Parameter	Function
`--read-only=true`	Run container with a read-only filesystem. Please read the docs.
`--user=1000:1000`	Run container with a non-root user. Please read the docs.

Environment variables from files (Docker secrets)¶

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications¶

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

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=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods¶

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

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" }}' lscr.io/linuxserver/beets:latest

Updating Info¶

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose¶

Update images:

All images:
```
docker-compose pull
```
Single image:
```
docker-compose pull beets
```

Update containers:

All containers:
```
docker-compose up -d
```
Single container:
```
docker-compose up -d beets
```

You can also remove the old dangling images:
```
docker image prune
```

Via Docker Run¶

Update the image:

docker pull lscr.io/linuxserver/beets:latest

Stop the running container:
```
docker stop beets
```
Delete the container:
```
docker rm beets
```
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:
```
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)¶

Tip

We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally¶

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-beets.git
cd docker-beets
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/beets:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

To help with development, we generate this dependency graph.

Init dependency graph

Versions¶

27.01.25: - Rebase to Alpine 3.21.
01.10.24: - Add packages required for Discogs plugin.
28.08.24: - Rebase to Alpine 3.20, switch from Pillow to Imagemagick.
23.12.23: - Rebase to Alpine 3.19.
25.08.23: - Rebase to Alpine 3.18, pin Pillow to 9.5.0.
07.07.23: - Deprecate armhf. As announced here
25.03.23: - Add requests_oauthlib required for beatport plugin.
24.02.23: - Rebase to Alpine 3.17, migrate to s6v3, install chromaprint from Alpine repos, add beetcamp plugin.
15.01.22: - Rebasing to alpine 3.15.
19.12.19: - Rebasing to alpine 3.11.
28.06.19: - Rebasing to alpine 3.10.
12.05.19: - Add flac and mp3val binaries required for badfiles plugin.
12.04.19: - Rebase to Alpine 3.9.
23.03.19: - Switching to new Base images, shift to arm32v7 tag.
11.03.19: - Swap copyartifacts for extrafiles, update endpoints with nightly tag.
01.03.19: - Switch to python3.
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

linuxserver/beets¶