Files
docker-sabnzbd/README.md
T

185 lines
8.6 KiB
Markdown
Raw Normal View History

2019-02-11 20:21:26 -08:00
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
2015-08-21 11:32:04 +01:00
2019-02-11 20:21:26 -08:00
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
2016-09-09 21:50:34 +01:00
2019-02-11 20:21:26 -08:00
* regular and timely application updates
* easy user mappings (PGID, PUID)
* custom base image with s6 overlay
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
* regular security updates
2015-08-21 11:32:04 +01:00
2019-02-11 20:21:26 -08:00
Find us at:
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
2015-08-21 11:32:04 +01:00
2019-02-11 20:21:26 -08:00
# [linuxserver/sabnzbd](https://github.com/linuxserver/docker-sabnzbd)
[![](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)
[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.
[![sabnzbd](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sabnzbd-banner.png)](http://sabnzbd.org/)
## Supported Architectures
2019-02-24 23:52:45 -05: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-11 20:21:26 -08:00
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 |
2015-08-21 11:32:04 +01:00
## Usage
2019-02-11 20:21:26 -08:00
Here are some example snippets to help you get started creating a container.
### docker
2015-08-21 11:32:04 +01:00
```
2019-02-11 20:21:26 -08:00
docker create \
--name=sabnzbd \
-e PUID=1001 \
-e PGID=1001 \
-e TZ=Europe/London \
-p 8080:8080 \
-p 9090:9090 \
-v <path to data>:/config \
-v <path to downloads>:/downloads \
-v <path to incomplete downloads>:/incomplete-downloads `#optional` \
--restart unless-stopped \
linuxserver/sabnzbd
2015-08-21 11:32:04 +01:00
```
2017-02-25 08:22:27 +00:00
2019-02-11 20:21:26 -08:00
### docker-compose
2017-02-25 08:22:27 +00:00
2019-02-11 20:21:26 -08:00
Compatible with docker-compose v2 schemas.
2017-02-25 08:22:27 +00:00
2019-02-11 20:21:26 -08:00
```
---
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
- <path to incomplete downloads>:/incomplete-downloads #optional
ports:
- 8080:8080
- 9090:9090
mem_limit: 4096m
restart: unless-stopped
```
2017-02-25 08:22:27 +00:00
2016-10-17 13:44:02 +01:00
## Parameters
2019-02-11 20:21:26 -08:00
Container 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.
2015-08-21 11:32:04 +01:00
2019-02-11 20:21:26 -08:00
| Parameter | Function |
| :----: | --- |
| `-p 8080` | HTTP port for the WebUI. |
| `-p 9090` | HTTPS port for the WebUI. |
| `-e PUID=1001` | for UserID - see below for explanation |
| `-e PGID=1001` | for GroupID - see below for explanation |
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
| `-v /config` | Local path for sabnzbd config files. |
| `-v /downloads` | Local path for finished downloads. |
| `-v /incomplete-downloads` | Local path for incomplete-downloads. |
2015-08-21 11:32:04 +01:00
2019-02-11 20:21:26 -08:00
## User / Group Identifiers
2019-02-11 20:21:26 -08: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`.
2015-08-21 11:32:04 +01:00
2019-02-11 20:21:26 -08:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2015-08-21 11:32:04 +01:00
2019-02-11 20:21:26 -08:00
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
2016-03-14 13:35:15 +00:00
```
2019-02-11 20:21:26 -08:00
$ id username
2016-03-14 13:35:15 +00:00
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
2015-08-21 11:32:04 +01:00
2019-02-11 20:21:26 -08:00
&nbsp;
## Application Setup
2016-03-14 13:40:59 +00:00
Initial setup is done from the http port.
2015-08-21 11:37:26 +01:00
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 https://sabnzbd.org/wiki/configuration/2.3/switches .
2015-08-21 11:32:04 +01:00
2019-02-11 20:21:26 -08:00
## Support Info
2015-08-21 11:32:04 +01:00
2016-03-14 13:35:15 +00:00
* Shell access whilst the container is running: `docker exec -it sabnzbd /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f sabnzbd`
2019-02-11 20:21:26 -08:00
* container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' sabnzbd`
2017-07-12 09:07:08 +01:00
* image version number
2019-02-11 20:21:26 -08:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sabnzbd`
## Updating Info
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
Below are the instructions for updating containers:
### Via Docker Run/Create
* Update the image: `docker pull linuxserver/sabnzbd`
* Stop the running container: `docker stop sabnzbd`
* Delete the container: `docker rm sabnzbd`
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* Start the new container: `docker start sabnzbd`
* You can also remove the old dangling images: `docker image prune`
### Via Docker Compose
* Update the image: `docker-compose pull linuxserver/sabnzbd`
* Let compose update containers as necessary: `docker-compose up -d`
* You can also remove the old dangling images: `docker image prune`
2015-08-21 11:32:04 +01:00
## Versions
2016-08-28 00:22:49 +01:00
* **25.02.19:** - Rebase to Bionic, add python deps for scripts.
2019-02-11 20:21:26 -08:00
* **26.01.19:** - Add pipeline logic and multi arch.
* **13.12.17:** - Fix continuation lines.
* **12.07.17:** - Add inspect commands to README, move to jenkins build and push.
* **10.04.17:** - Bump to 2.0 Release.
* **25.02.17:** - Switch to nobetas repo for master/latest branch and add unstable branch.
* **08.02.17:** - Add pythonioenconding=utf8 as env.
* **15.09.16:** - Compile par2 multicore as per latest info sabnzbd git [readme](https://github.com/sabnzbd/sabnzbd#resolving-dependencies).
* **11.09.16:** - Bump to release of 1.10.
* **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.
* **17.03.16:** - Bump to install 1.0 final at startup.
* **14.03.16:** - Refresh image to pick up latest RC.
* **23.01.15:** - Refresh image.
* **14.12.15:** - Refresh image to pick up latest beta.
* **21.08.15:** - Initial Release.