docker-documentation/images/docker-bazarr.md

153 wiersze
6.7 KiB
Markdown
Czysty Zwykły widok Historia

2019-10-03 21:39:07 +00:00
# [linuxserver/bazarr](https://github.com/linuxserver/docker-bazarr)
2019-02-07 22:39:13 +00:00
2019-10-31 22:39:06 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-bazarr.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-bazarr)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-bazarr.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-bazarr/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-bazarr/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-bazarr/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/bazarr)
2019-10-03 21:39:07 +00:00
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/bazarr.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/bazarr "Get your own version badge on microbadger.com")
2019-10-31 22:39:06 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/bazarr.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/bazarr)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/bazarr.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/bazarr)
2019-10-03 21:39:07 +00:00
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-bazarr/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bazarr/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bazarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/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
2019-02-11 04:00:26 +00:00
Simply pulling `linuxserver/bazarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-07 22:39:13 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2019-10-03 21:39:07 +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
2019-10-03 21:39:07 +00:00
2019-02-07 22:39:13 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-10-03 21:39:07 +00:00
```
2019-02-07 22:39:13 +00:00
docker create \
--name=bazarr \
2019-03-02 20:52:39 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-07 22:39:13 +00:00
-e TZ=Europe/London \
2019-06-17 15:21:21 +00:00
-e UMASK_SET=022 `#optional` \
2019-02-07 22:39:13 +00:00
-p 6767:6767 \
-v </path/to/bazarr/config>:/config \
-v </path/to/movies>:/movies \
2019-05-08 11:19:54 +00:00
-v </path/to/tv>:/tv \
2019-02-07 22:39:13 +00:00
--restart unless-stopped \
linuxserver/bazarr
```
2019-10-03 21:39:07 +00:00
You can choose between ,using tags, various branch versions of bazarr, no tag is required to remain on the main branch.
Add one of the tags, if required, to the linuxserver/bazarr line of the run/create command in the following format, linuxserver/bazarr:development
The development tag will be the latest commit in the development branch of bazarr.
HOWEVER , USE THE DEVELOPMENT BRANCH AT YOUR OWN PERIL !!!!!!!!!
2019-02-07 22:39:13 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
bazarr:
image: linuxserver/bazarr
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
2019-06-17 15:21:21 +00:00
- UMASK_SET=022 #optional
2019-02-07 22:39:13 +00:00
volumes:
- </path/to/bazarr/config>:/config
- </path/to/movies>:/movies
2019-05-08 11:19:54 +00:00
- </path/to/tv>:/tv
2019-02-07 22:39:13 +00:00
ports:
- 6767:6767
restart: unless-stopped
```
## Parameters
2019-10-03 21:39:07 +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
2019-10-03 21:39:07 +00:00
### Ports (`-p`)
2019-02-07 22:39:13 +00:00
| Parameter | Function |
2019-10-03 21:39:07 +00:00
| :----: | --- |
2019-02-07 22:39:13 +00:00
| `6767` | Allows HTTP access to the internal webserver. |
2019-10-03 21:39:07 +00:00
### Environment Variables (`-e`)
2019-02-07 22:39:13 +00:00
| Env | Function |
2019-10-03 21:39:07 +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 |
2019-06-17 15:21:21 +00:00
| `UMASK_SET=022` | control permissions of files and directories created by Bazarr |
2019-02-07 22:39:13 +00:00
2019-10-03 21:39:07 +00:00
### Volume Mappings (`-v`)
2019-02-07 22:39:13 +00:00
| Volume | Function |
2019-10-03 21:39:07 +00:00
| :----: | --- |
2019-02-07 22:39:13 +00:00
| `/config` | Bazarr data |
| `/movies` | Location of your movies |
| `/tv` | Location of your TV Shows |
2019-10-03 21:39:07 +00:00
2019-02-07 22:39:13 +00:00
## User / Group Identifiers
2019-10-03 21:39:07 +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
2019-10-03 21:39:07 +00:00
```
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
```
## Application Setup
2019-10-03 21:39:07 +00:00
- 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
## 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
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/bazarr`
## Versions
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.