2020-06-29 07:29:55 +00:00
# linuxserver/beets
[](https://github.com/linuxserver/docker-beets) [](https://github.com/linuxserver/docker-beets/releases) [](https://github.com/linuxserver/docker-beets/packages) [](https://gitlab.com/Linuxserver.io/docker-beets/container_registry) [](https://microbadger.com/images/linuxserver/beets) [](https://hub.docker.com/r/linuxserver/beets) [](https://hub.docker.com/r/linuxserver/beets) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-beets/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/beets/latest/index.html)
2019-02-07 17:09:21 +00:00
2019-02-12 14:41:48 +00:00
[Beets ](http://beets.io/ ) 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.
2019-02-07 17:09:21 +00:00
2019-02-12 14:41:48 +00:00
## Supported Architectures
2019-02-07 17:09:21 +00:00
2019-09-07 02:06:03 +00:00
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 ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-12 14:41:48 +00:00
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 |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-12 14:41:48 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 22:12:48 +00:00
| armhf | arm32v7-latest |
2019-02-07 17:09:21 +00:00
2019-05-04 02:06:11 +00:00
## 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 |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-05-04 02:06:11 +00:00
| latest | Stable Beets Releases |
| nightly | Built against head of Beets git, generally considered unstable but a likely choice for power users of the application. |
2019-03-17 20:44:23 +00:00
2019-02-07 17:09:21 +00:00
## Usage
2019-02-12 14:41:48 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-06-29 07:29:55 +00:00
```text
2019-02-07 17:09:21 +00:00
docker create \
2019-02-12 14:41:48 +00:00
--name=beets \
2019-03-02 03:05:39 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-12 14:41:48 +00:00
-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
2019-02-07 17:09:21 +00:00
```
2019-02-12 14:41:48 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-11 02:06:29 +00:00
version: "2.1"
2019-02-12 14:41:48 +00:00
services:
beets:
image: linuxserver/beets
container_name: beets
environment:
2019-03-02 03:05:39 +00:00
- PUID=1000
- PGID=1000
2019-02-12 14:41:48 +00:00
- TZ=Europe/London
volumes:
- < /path/to/appdata/config>:/config
- < /path/to/music/library>:/music
- < /path/to/ingest>:/downloads
ports:
- 8337:8337
restart: unless-stopped
```
2019-02-07 17:09:21 +00:00
2019-02-12 14:41:48 +00:00
## Parameters
2019-02-07 17:09:21 +00:00
2020-06-29 07:29:55 +00:00
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.
2019-02-07 17:09:21 +00:00
2020-06-29 07:29:55 +00:00
### Ports \(`-p`\)
2019-02-07 17:09:21 +00:00
2019-02-12 14:41:48 +00:00
| Parameter | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-12 14:41:48 +00:00
| `8337` | Application WebUI |
2019-02-07 17:09:21 +00:00
2020-06-29 07:29:55 +00:00
### Environment Variables \(`-e`\)
2019-02-07 17:09:21 +00:00
2019-02-12 14:41:48 +00:00
| Env | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-03-02 03:05:39 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-12 14:41:48 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-02-07 17:09:21 +00:00
2020-06-29 07:29:55 +00:00
### Volume Mappings \(`-v`\)
2019-02-07 17:09:21 +00:00
2019-02-12 14:41:48 +00:00
| Volume | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-12 14:41:48 +00:00
| `/config` | Configuration files. |
| `/music` | Music library |
| `/downloads` | Non processed music |
2019-02-07 17:09:21 +00:00
2020-06-29 07:29:55 +00:00
## Environment variables from files \(Docker secrets\)
2020-05-30 02:06:20 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2020-06-29 07:29:55 +00:00
```text
2020-05-30 02:06:20 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-06-29 07:29:55 +00:00
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 ](https://en.wikipedia.org/wiki/Umask ) before asking for support.
2020-05-02 02:05:51 +00:00
2019-02-12 14:41:48 +00:00
## User / Group Identifiers
2019-02-07 17:09:21 +00:00
2020-06-29 07:29:55 +00:00
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` .
2019-02-07 17:09:21 +00:00
2019-02-12 14:41:48 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-02-07 17:09:21 +00:00
2019-03-02 03:05:39 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-07 17:09:21 +00:00
2020-06-29 07:29:55 +00:00
```text
2019-02-12 14:41:48 +00:00
$ id username
2019-03-02 03:05:39 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-12 14:41:48 +00:00
```
2019-02-07 17:09:21 +00:00
2020-04-11 02:06:29 +00:00
## Docker Mods
2020-06-29 07:29:55 +00:00
[](https://mods.linuxserver.io/?mod=beets)
2020-04-11 02:06:29 +00:00
2020-06-29 07:29:55 +00:00
We publish various [Docker Mods ](https://github.com/linuxserver/docker-mods ) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
2019-10-05 02:05:56 +00:00
2019-02-12 14:41:48 +00:00
## Support Info
2019-02-07 17:09:21 +00:00
2019-09-07 02:06:03 +00:00
* Shell access whilst the container is running:
2019-02-12 14:41:48 +00:00
* `docker exec -it beets /bin/bash`
2019-09-07 02:06:03 +00:00
* To monitor the logs of the container in realtime:
2019-02-12 14:41:48 +00:00
* `docker logs -f beets`
2019-09-07 02:06:03 +00:00
* Container version number
2019-02-12 14:41:48 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' beets`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/beets`
2019-02-07 17:09:21 +00:00
## Versions
2019-12-20 17:40:33 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-06-30 19:20:12 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-05-29 20:05:13 +00:00
* **12.05.19:** - Add flac and mp3val binaries required for badfiles plugin.
2019-05-04 02:06:11 +00:00
* **12.04.19:** - Rebase to Alpine 3.9.
2019-03-24 22:12:48 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-05-04 02:06:11 +00:00
* **11.03.19:** - Swap copyartifacts for extrafiles, update endpoints with nightly tag.
2019-03-02 04:54:22 +00:00
* **01.03.19:** - Switch to python3.
2019-02-12 14:41:48 +00:00
* **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.
2020-06-29 07:29:55 +00:00
* **02.01.18:** - Deprecate cpu\_core routine lack of scaling.
2019-02-12 14:41:48 +00:00
* **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 ](https://github.com/sbarakat/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
2020-06-29 07:29:55 +00:00
