Bot Updating Templated Files

LICENSE
LinuxServer-CI 2019-02-12 14:41:48 +00:00
rodzic e086bd8267
commit 2ab6f91230
1 zmienionych plików z 120 dodań i 80 usunięć

Wyświetl plik

@ -1,111 +1,151 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/beets](https://github.com/linuxserver/docker-beets)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: http://beets.io/
[hub]: https://hub.docker.com/r/linuxserver/beets/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/beets.svg)](https://microbadger.com/images/linuxserver/beets "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/beets.svg)](https://microbadger.com/images/linuxserver/beets "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/beets.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/beets.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-beets/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-beets/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/beets/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/beets/latest/index.html)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: [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.
* [forum.linuxserver.io][forumurl]
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/beets ## Supported Architectures
[![](https://images.microbadger.com/badges/version/linuxserver/beets.svg)](https://microbadger.com/images/linuxserver/beets "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/beets.svg)](https://microbadger.com/images/linuxserver/beets "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/beets.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/beets.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-beets)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-beets/)
[Beets][appurl] 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. 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).
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 |
[![beets](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/beets-icon.png)][appurl]
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
``` ```
docker create \ docker create \
--name=beets \ --name=beets \
-v <path to config>:/config \ -e PUID=1001 \
-v <path to music>:/music \ -e PGID=1001 \
-v <path to non-processed music>:/downloads \ -e TZ=Europe/London \
-e PGID=<gid> -e PUID=<uid> \
-p 8337:8337 \ -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 linuxserver/beets
``` ```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
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 ## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. 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.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 ### Ports (`-p`)
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
| Parameter | Function |
| :----: | --- |
| `8337` | Application WebUI |
* `-p 8337` - the port(s) ### Environment Variables (`-e`)
* `-v /config` - Configuration files
* `-v /music` - Music library location
* `-v /downloads` - Non-processed music
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it beets /bin/bash`. | 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. |
### User / Group Identifiers ### Volume Mappings (`-v`)
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. | Volume | Function |
| :----: | --- |
| `/config` | Configuration files. |
| `/music` | Music library |
| `/downloads` | Non processed music |
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
## 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 <dockeruser> $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
``` ```
## Setting up the application
Edit the config file in /config
To edit the config from within the container use `beet config -e` ## Support Info
For a command prompt as user abc `docker exec -it -u abc beets bash`
See [Beets][appurl] for more info.
Contains [beets-copyartifacts](https://github.com/sbarakat/beets-copyartifacts) plugin, [configuration details](https://github.com/sbarakat/beets-copyartifacts#configuration)
## Info
* 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`
* 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 ## Versions
+ **07.02.19:** Add fftw-dev build dependency for chromaprint. * **07.02.19:** - Add fftw-dev build dependency for chromaprint.
+ **28.01.19:** Add pipeline logic and multi arch. * **28.01.19:** - Add pipeline logic and multi arch.
+ **15.08.18:** Rebase to alpine 3.8, use alpine repo version of pylast. * **15.08.18:** - Rebase to alpine 3.8, use alpine repo version of pylast.
+ **12.08.18:** Add requests pip package. * **12.08.18:** - Add requests pip package.
+ **04.03.18:** Upgrade mp3gain to 1.6.1. * **04.03.18:** - Upgrade mp3gain to 1.6.1.
+ **02.01.18:** Deprecate cpu_core routine lack of scaling. * **02.01.18:** - Deprecate cpu_core routine lack of scaling.
+ **27.12.17:** Add beautifulsoup4 pip package. * **27.12.17:** - Add beautifulsoup4 pip package.
+ **06.12.17:** Rebase to alpine linux 3.7. * **06.12.17:** - Rebase to alpine linux 3.7.
+ **25.05.17:** Rebase to alpine linux 3.6. * **25.05.17:** - Rebase to alpine linux 3.6.
+ **06.02.17:** Rebase to alpine linux 3.5. * **06.02.17:** - Rebase to alpine linux 3.5.
+ **16.01.17:** Add packages required for replaygain. * **16.01.17:** - Add packages required for replaygain.
+ **24.12.16:** Add [beets-copyartifacts](https://github.com/sbarakat/beets-copyartifacts) plugin. * **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 * **07.12.16:** - Edit cmake options for chromaprint, should now build and install fpcalc, add gstreamer lib
+ **14.10.16:** Add version layer information. * **14.10.16:** - Add version layer information.
+ **01.10.16:** Add nano and editor variable - * **01.10.16:** - Add nano and editor variable to allow editing of the config from the container command line.
to allow editing of the config from the container command line. * **30.09.16:** - Fix umask.
+ **30.09.16:** Fix umask. * **24.09.16:** - Rebase to alpine linux.
+ **24.09.16:** Rebase to alpine linux. * **10.09.16:** - Add layer badges to README.
+ **10.09.16:** Add layer badges to README. * **05.01.16:** - Change ffpmeg repository, other version crashes container
+ **05.01.16:** Change ffpmeg repository, other version crashes container * **06.11.15:** - Initial Release
+ **06.11.15:** Initial Release * **29.11.15:** - Take out term setting, causing issues with key entry for some users
+ **29.11.15:** Take out term setting, causing issues with key entry for some users