kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Templated Files
LinuxServer-CI
rodzic
dd230ea7da
commit
ca4824a114
|
|
@ -1,111 +1,163 @@
|
|||
[linuxserverurl]: https://linuxserver.io
|
||||
[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/sabnzbd](https://github.com/linuxserver/docker-sabnzbd)
|
||||
|
||||
[][linuxserverurl]
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/sabnzbd "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/sabnzbd "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sabnzbd/job/master/)
|
||||
[](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:
|
||||
* [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!
|
||||
[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.
|
||||
|
||||
# linuxserver/sabnzbd
|
||||
[](https://microbadger.com/images/linuxserver/sabnzbd "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/sabnzbd "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-sabnzbd/)
|
||||
## Supported Architectures
|
||||
|
||||
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).
|
||||
|
||||
[][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
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
docker create --name=sabnzbd \
|
||||
-v <path to data>:/config \
|
||||
-v <path to downloads>:/downloads \
|
||||
-v <path to incomplete downloads>:/incomplete-downloads \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-e TZ=<timezone> \
|
||||
-p 8080:8080 -p 9090:9090 \
|
||||
linuxserver/sabnzbd
|
||||
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
|
||||
```
|
||||
|
||||
## Tags
|
||||
|
||||
You can choose ,using a tag, to use the unstable branch.
|
||||
Stable is the default and requires no tag
|
||||
### docker-compose
|
||||
|
||||
(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:-
|
||||
|
||||
`linuxserver/sabnzbd:unstable`
|
||||
```yaml
|
||||
---
|
||||
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
|
||||
|
||||
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
|
||||
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
|
||||
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
|
||||
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.
|
||||
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| `8080` | HTTP port for the WebUI. |
|
||||
| `9090` | HTTPS port for the WebUI. |
|
||||
|
||||
|
||||
* `-p 8080` - http port for the webui
|
||||
* `-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
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
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)
|
||||
```
|
||||
|
||||
## Setting up the application
|
||||
## Application Setup
|
||||
|
||||
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.
|
||||
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`
|
||||
* To monitor the logs of the container in realtime: `docker logs -f sabnzbd`
|
||||
## Support Info
|
||||
|
||||
* container version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' sabnzbd`
|
||||
|
||||
* image version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sabnzbd`
|
||||
* 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`
|
||||
* Container version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' sabnzbd`
|
||||
* Image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sabnzbd`
|
||||
|
||||
## Versions
|
||||
|
||||
+ **26.01.19:** Add inspect commands to README, move to jenkins build and push.
|
||||
+ **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:** Intial Release.
|
||||
* **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.
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue