mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

pull/1/head
LinuxServer-CI 2019-02-12 14:36:12 +00:00
rodzic dd230ea7da
commit ca4824a114
1 zmienionych plików z 125 dodań i 73 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

198
images/docker-sabnzbd.md
Wyświetl plik

@ -1,111 +1,163 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/sabnzbd](https://github.com/linuxserver/docker-sabnzbd)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: http://sabnzbd.org/
[hub]: https://hub.docker.com/r/linuxserver/sabnzbd/
[![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/sabnzbd.svg)](https://microbadger.com/images/linuxserver/sabnzbd "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/sabnzbd.svg)](https://microbadger.com/images/linuxserver/sabnzbd "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sabnzbd.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sabnzbd.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-sabnzbd/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sabnzbd/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sabnzbd/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sabnzbd/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: [Sabnzbd](http://sabnzbd.org/) makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction.
* [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/sabnzbd ## Supported Architectures
[![](https://images.microbadger.com/badges/version/linuxserver/sabnzbd.svg)](https://microbadger.com/images/linuxserver/sabnzbd "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/sabnzbd.svg)](https://microbadger.com/images/linuxserver/sabnzbd "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sabnzbd.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sabnzbd.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-sabnzbd)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-sabnzbd/)
SABnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction. 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).
[![sabnzbd](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sabnzbd-banner.png)][appurl] Simply pulling `linuxserver/sabnzbd` 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 |
## 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 SABnzbd releases |
| unstable | Beta/Stable SABnzbd releases at edge |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
``` ```
docker create --name=sabnzbd \ docker create \
-v <path to data>:/config \ --name=sabnzbd \
-v <path to downloads>:/downloads \ -e PUID=1001 \
-v <path to incomplete downloads>:/incomplete-downloads \ -e PGID=1001 \
-e PGID=<gid> -e PUID=<uid> \ -e TZ=Europe/London \
-e TZ=<timezone> \ -p 8080:8080 \
-p 8080:8080 -p 9090:9090 \ -p 9090:9090 \
linuxserver/sabnzbd -v <path to data>:/config \
-v <path to downloads>:/downloads \
-v <path to incomplete downloads>:/incomplete-downloads `#optional` \
--restart unless-stopped \
linuxserver/sabnzbd
``` ```
## Tags
You can choose ,using a tag, to use the unstable branch. ### docker-compose
Stable is the default and requires no tag
(at times both branches may have the same version, but the stable/latest branch should never contain an alpha/beta/rc version) Compatible with docker-compose v2 schemas.
Add the tag, if required, to the linuxserver/sabnzbd line of the run/create command in the following format:- ```yaml
---
`linuxserver/sabnzbd:unstable` version: "2"
services:
sabnzbd:
image: linuxserver/sabnzbd
container_name: sabnzbd
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
volumes:
- <path to data>:/config
- <path to downloads>:/downloads
volumes:
- <path to incomplete downloads>:/incomplete-downloads #optional
ports:
- 8080:8080
- 9090:9090
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 |
| :----: | --- |
| `8080` | HTTP port for the WebUI. |
| `9090` | HTTPS port for the WebUI. |
* `-p 8080` - http port for the webui ### Environment Variables (`-e`)
* `-p 9090` - https port for the webui *see note below*
* `-v /config` - local path for sabnzbd config files
* `-v /downloads` local path for finished downloads
* `-v /incomplete-downloads` local path for incomplete-downloads - *optional*
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
* `-e TZ` for setting timezone information, eg Europe/London
It is based on ubuntu xenial with s6 overlay, for shell access whilst the container is running do `docker exec -it sabnzbd /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` | Local path for sabnzbd config files. |
| `/downloads` | Local path for finished downloads. |
| `/incomplete-downloads` | Local path for incomplete-downloads. |
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 ## Application Setup
Initial setup is done from the http port. Initial setup is done from the http port.
Https access for sabnzbd needs to be enabled in either the intial setup wizard or in the configure settings of the webui, be sure to use 9090 as port for https. Https access for sabnzbd needs to be enabled in either the intial setup wizard or in the configure settings of the webui, be sure to use 9090 as port for https.
See here for info on some of the switch settings for sabnzbd http://wiki.sabnzbd.org/configure-switches See here for info on some of the switch settings for sabnzbd http://wiki.sabnzbd.org/configure-switches
## Info
* Shell access whilst the container is running: `docker exec -it sabnzbd /bin/bash` ## Support Info
* To monitor the logs of the container in realtime: `docker logs -f sabnzbd`
* container version number * Shell access whilst the container is running:
* `docker exec -it sabnzbd /bin/bash`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' sabnzbd` * To monitor the logs of the container in realtime:
* `docker logs -f sabnzbd`
* image version number * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' sabnzbd`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sabnzbd` * Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sabnzbd`
## Versions ## Versions
+ **26.01.19:** Add inspect commands to README, move to jenkins build and push. * **26.01.19:** - Add pipeline logic and multi arch.
+ **12.07.17:** Add inspect commands to README, move to jenkins build and push. * **13.12.17:** - Fix continuation lines.
+ **10.04.17:** Bump to 2.0 Release. * **12.07.17:** - Add inspect commands to README, move to jenkins build and push.
+ **25.02.17:** Switch to nobetas repo for master/latest branch and add unstable branch. * **10.04.17:** - Bump to 2.0 Release.
+ **08.02.17:** Add pythonioenconding=utf8 as env. * **25.02.17:** - Switch to nobetas repo for master/latest branch and add unstable branch.
+ **15.09.16:** Compile par2 multicore as per latest info sabnzbd git [readme](https://github.com/sabnzbd/sabnzbd#resolving-dependencies) * **08.02.17:** - Add pythonioenconding=utf8 as env.
+ **11.09.16:** Bump to release of 1.10 * **15.09.16:** - Compile par2 multicore as per latest info sabnzbd git [readme](https://github.com/sabnzbd/sabnzbd#resolving-dependencies).
+ **09.09.16:** Rebase back to xenial, * **11.09.16:** - Bump to release of 1.10.
issues with alpine version of python and 1.10 branch of sab. * **09.09.16:** - Rebase back to xenial, issues with alpine version of python and 1.10 branch of sab.
+ **28.08.16:** Rebase to alpine, using git version of sab. * **28.08.16:** - Rebase to alpine, using git version of sab.
+ **17.03.16:** Bump to install 1.0 final at startup * **17.03.16:** - Bump to install 1.0 final at startup.
+ **14.03.16:** Refresh image to pick up latest RC * **14.03.16:** - Refresh image to pick up latest RC.
+ **23.01.15:** Refresh image. * **23.01.15:** - Refresh image.
+ **14.12.15:** Refresh image to pick up latest beta * **14.12.15:** - Refresh image to pick up latest beta.
+ **21.08.15:** Intial Release. * **21.08.15:** - Initial Release.