diff --git a/images/docker-musicbrainz.md b/images/docker-musicbrainz.md index e49d055f8..f1457eb3a 100644 --- a/images/docker-musicbrainz.md +++ b/images/docker-musicbrainz.md @@ -1,12 +1,13 @@ # [linuxserver/musicbrainz](https://github.com/linuxserver/docker-musicbrainz) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-musicbrainz.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-musicbrainz/releases) -[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/musicbrainz.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/musicbrainz "Get your own version badge on microbadger.com") -[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/musicbrainz.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/musicbrainz "Get your own version badge on microbadger.com") -[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/musicbrainz.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/musicbrainz) -[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/musicbrainz.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/musicbrainz) -[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-musicbrainz/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-musicbrainz/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/musicbrainz/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/musicbrainz/latest/index.html) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-musicbrainz.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-musicbrainz) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-musicbrainz.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-musicbrainz/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-musicbrainz/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/Linuxserver.io/docker-musicbrainz/container_registry) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/musicbrainz.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/musicbrainz "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/musicbrainz.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/musicbrainz) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/musicbrainz.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/musicbrainz) +[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-musicbrainz%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-musicbrainz/job/master/) [Musicbrainz](https://musicbrainz.org/) is an open music encyclopedia that collects music metadata and makes it available to the public. @@ -14,7 +15,7 @@ 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/). -Simply pulling `linuxserver/musicbrainz` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. +Simply pulling `ghcr.io/linuxserver/musicbrainz` 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: @@ -29,35 +30,16 @@ The architectures supported by this image are: Here are some example snippets to help you get started creating a container from this image. -### docker - -``` -docker create \ - --name=musicbrainz \ - -e PUID=1000 \ - -e PGID=1000 \ - -e TZ=Europe/London \ - -e BRAINZCODE= \ - -e WEBADDRESS= \ - -e NPROC= `#optional` \ - -p 5000:5000 \ - -v :/config \ - -v :/data \ - --restart unless-stopped \ - linuxserver/musicbrainz -``` - - -### docker-compose +### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose)) Compatible with docker-compose v2 schemas. ```yaml --- -version: "2" +version: "2.1" services: musicbrainz: - image: linuxserver/musicbrainz + image: ghcr.io/linuxserver/musicbrainz container_name: musicbrainz environment: - PUID=1000 @@ -74,6 +56,25 @@ services: restart: unless-stopped ``` +### docker cli + +``` +docker run -d \ + --name=musicbrainz \ + -e PUID=1000 \ + -e PGID=1000 \ + -e TZ=Europe/London \ + -e BRAINZCODE= \ + -e WEBADDRESS= \ + -e NPROC= `#optional` \ + -p 5000:5000 \ + -v :/config \ + -v :/data \ + --restart unless-stopped \ + ghcr.io/linuxserver/musicbrainz +``` + + ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. @@ -105,6 +106,24 @@ Docker images are configured using parameters passed at runtime (such as those a +## 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__PASSWORD=/run/secrets/mysecretpassword +``` + +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](https://en.wikipedia.org/wiki/Umask) 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`. @@ -129,6 +148,11 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * It appears there are issues with unraid and using /mnt/user/cache/appdata instead of /mnt/cache/appdata, use /mnt/cache/appdata. +## Docker Mods +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=musicbrainz&query=%24.mods%5B%27musicbrainz%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=musicbrainz "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") + +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) 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 @@ -139,7 +163,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * Container version number * `docker inspect -f '{{ index .Config.Labels "build_version" }}' musicbrainz` * Image version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/musicbrainz` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/musicbrainz` ## Versions