Search…
Images
Powered By GitBook
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 and our announcement here.
Simply pulling lscr.io/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
arm32v7-latest

Version Tags

This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
Tag
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.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
beets:
5
image: lscr.io/linuxserver/beets
6
container_name: beets
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=Europe/London
11
volumes:
12
- </path/to/appdata/config>:/config
13
- </path/to/music/library>:/music
14
- </path/to/ingest>:/downloads
15
ports:
16
- 8337:8337
17
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=beets \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=Europe/London \
6
-p 8337:8337 \
7
-v </path/to/appdata/config>:/config \
8
-v </path/to/music/library>:/music \
9
-v </path/to/ingest>:/downloads \
10
--restart unless-stopped \
11
lscr.io/linuxserver/beets
Copied!

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=1000
for UserID - see below for explanation
PGID=1000
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

Miscellaneous Options

Parameter
Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword 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 user as below:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

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

Versions

    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
Last modified 20d ago