docker-documentation/images/docker-bazarr.md

182 wiersze
9.1 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-12 16:45:28 +00:00
---
title: bazarr
---
2021-04-18 04:46:18 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-bazarr/blob/master/.github/CONTRIBUTING.md -->
2020-07-02 21:38:52 +00:00
# [linuxserver/bazarr](https://github.com/linuxserver/docker-bazarr)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-bazarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-bazarr)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-bazarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-bazarr/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-bazarr/packages)
2020-12-15 19:34:06 +00:00
[![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-bazarr/container_registry)
2020-07-02 21:38:52 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/bazarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/bazarr)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/bazarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/bazarr)
[![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-bazarr%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bazarr/job/master/)
2020-11-02 15:10:10 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fbazarr%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/bazarr/latest/index.html)
2019-02-07 22:39:13 +00:00
2019-05-08 11:19:54 +00:00
[Bazarr](https://www.bazarr.media/) is a companion application to Sonarr and Radarr. It can manage and download subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you.
2019-02-07 22:39:13 +00:00
## Supported Architectures
2019-09-05 21:38:58 +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-07 22:39:13 +00:00
2020-11-02 15:10:10 +00:00
Simply pulling `ghcr.io/linuxserver/bazarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-11 04:00:26 +00:00
2019-02-07 22:39:13 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-07-02 21:38:52 +00:00
| :----: | --- |
2019-02-07 22:39:13 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:31:01 +00:00
| armhf | arm32v7-latest |
2019-02-07 22:39:13 +00:00
2021-04-07 22:07:30 +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 |
| :----: | --- |
| latest | Stable releases from Bazarr |
| development | Pre-releases from Bazarr |
2020-07-02 21:38:52 +00:00
2021-04-18 04:46:18 +00:00
## Application Setup
- Once running the URL will be `http://<host-ip>:6767`.
- You must complete all the setup parameters in the webui before you can save the config.
2019-02-07 22:39:13 +00:00
## Usage
2021-07-04 04:43:25 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-02-07 22:39:13 +00:00
2021-07-04 04:43:25 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-02-07 22:39:13 +00:00
```yaml
---
2020-04-09 21:39:04 +00:00
version: "2.1"
2019-02-07 22:39:13 +00:00
services:
bazarr:
2020-11-02 15:10:10 +00:00
image: ghcr.io/linuxserver/bazarr
2019-02-07 22:39:13 +00:00
container_name: bazarr
environment:
2019-03-02 20:52:39 +00:00
- PUID=1000
- PGID=1000
2019-02-07 22:39:13 +00:00
- TZ=Europe/London
volumes:
2021-04-07 22:07:30 +00:00
- /path/to/bazarr/config:/config
- /path/to/movies:/movies #optional
- /path/to/tv:/tv #optional
2019-02-07 22:39:13 +00:00
ports:
- 6767:6767
restart: unless-stopped
```
2021-07-04 04:43:25 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-08 00:20:20 +00:00
2021-04-18 04:46:18 +00:00
```bash
2020-10-08 00:20:20 +00:00
docker run -d \
--name=bazarr \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 6767:6767 \
2021-04-07 22:07:30 +00:00
-v /path/to/bazarr/config:/config \
-v /path/to/movies:/movies `#optional` \
-v /path/to/tv:/tv `#optional` \
2020-10-08 00:20:20 +00:00
--restart unless-stopped \
2020-11-02 15:10:10 +00:00
ghcr.io/linuxserver/bazarr
2020-10-08 00:20:20 +00:00
```
2019-02-07 22:39:13 +00:00
## Parameters
2020-07-02 21:38:52 +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 22:39:13 +00:00
2020-07-02 21:38:52 +00:00
### Ports (`-p`)
2019-02-07 22:39:13 +00:00
| Parameter | Function |
2020-07-02 21:38:52 +00:00
| :----: | --- |
2019-02-07 22:39:13 +00:00
| `6767` | Allows HTTP access to the internal webserver. |
2020-07-02 21:38:52 +00:00
### Environment Variables (`-e`)
2019-02-07 22:39:13 +00:00
| Env | Function |
2020-07-02 21:38:52 +00:00
| :----: | --- |
2019-03-02 20:52:39 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-07 22:39:13 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
2020-07-02 21:38:52 +00:00
### Volume Mappings (`-v`)
2019-02-07 22:39:13 +00:00
| Volume | Function |
2020-07-02 21:38:52 +00:00
| :----: | --- |
2019-02-07 22:39:13 +00:00
| `/config` | Bazarr data |
| `/movies` | Location of your movies |
| `/tv` | Location of your TV Shows |
2020-07-02 21:38:52 +00:00
## Environment variables from files (Docker secrets)
2020-05-28 21:38:58 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-18 04:46:18 +00:00
```bash
2020-05-28 21:38:58 +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-07-02 21:38:52 +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.
2019-02-07 22:39:13 +00:00
## User / Group Identifiers
2020-07-02 21:38:52 +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 22:39:13 +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-03-02 20:52:39 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-07 22:39:13 +00:00
2021-04-18 04:46:18 +00:00
```bash
2019-02-07 22:39:13 +00:00
$ id username
2019-03-02 20:52:39 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-07 22:39:13 +00:00
```
2020-04-09 21:39:04 +00:00
## Docker Mods
2021-04-18 04:46:18 +00:00
2020-10-08 00:20:20 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=bazarr&query=%24.mods%5B%27bazarr%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=bazarr "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.")
2020-04-09 21:39:04 +00:00
2020-10-08 00:20:20 +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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-04-09 21:39:04 +00:00
2019-02-07 22:39:13 +00:00
## Support Info
2019-09-05 21:38:58 +00:00
* Shell access whilst the container is running:
2019-02-07 22:39:13 +00:00
* `docker exec -it bazarr /bin/bash`
2019-09-05 21:38:58 +00:00
* To monitor the logs of the container in realtime:
2019-02-07 22:39:13 +00:00
* `docker logs -f bazarr`
2019-09-05 21:38:58 +00:00
* Container version number
2019-02-07 22:39:13 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' bazarr`
* Image version number
2020-11-02 15:10:10 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/bazarr`
2019-02-07 22:39:13 +00:00
## Versions
2021-05-17 16:07:09 +00:00
* **16.05.21:** - Use wheel index.
2021-04-19 16:54:18 +00:00
* **19.04.21:** - Install from release zip.
2021-04-07 22:07:30 +00:00
* **07.04.21:** - Move app to /app/bazarr/bin, add `package_info`.
2021-02-12 16:45:28 +00:00
* **23.01.21:** - Rebasing to alpine 3.13.
2021-01-23 21:14:17 +00:00
* **23.01.21:** - Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information.
2020-06-08 16:20:38 +00:00
* **01.06.20:** - Rebasing to alpine 3.12.
2020-05-13 21:41:00 +00:00
* **13.05.20:** - Add donation links for Bazarr to Github sponsors button and container log.
2020-04-09 21:52:22 +00:00
* **08.04.20:** - Removed /movies and /tv volumes from Dockerfiles.
* **28.12.19:** - Upgrade to Python 3.
2019-12-20 17:38:21 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-06-30 19:42:22 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-06-17 15:21:21 +00:00
* **13.06.19:** - Add env variable for setting umask.
2019-06-23 21:14:30 +00:00
* **12.06.19:** - Swap to install deps using maintainers requirements.txt, add ffmpeg for ffprobe.
2019-05-08 11:19:54 +00:00
* **17.04.19:** - Add default UTC timezone if user does not set it.
2019-03-24 19:31:01 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 04:49:23 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-07 22:39:13 +00:00
* **11.09.18:** - Initial release.