diff --git a/README.md b/README.md index ef66dca..a492d00 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,189 @@ -[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.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :- -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! + * 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 -# linuxserver/sabnzbd -[![](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/) +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). -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. +# PSA: Changes are happening -[![sabnzbd](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sabnzbd-banner.png)][appurl] +From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag. + +TLDR: Multi-arch support is changing from multiple repos to one repo per container image. + +# [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 + +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). + +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. + +### docker + ``` -docker create --name=sabnzbd \ --v :/config \ --v :/downloads \ --v :/incomplete-downloads \ --e PGID= -e PUID= \ --e TZ= \ --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 :/config \ + -v :/downloads \ + -v :/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` +``` +--- +version: "2" +services: + sabnzbd: + image: linuxserver/sabnzbd + container_name: sabnzbd + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + volumes: + - :/config + - :/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.` +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. +| 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. | -* `-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 +## User / Group Identifiers -It is based on ubuntu xenial with s6 overlay, for shell access whilst the container is running do `docker exec -it sabnzbd /bin/bash`. +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`. -### User / Group Identifiers +Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. -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" ™. - -In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: +In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below: ``` - $ id + $ 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 + +## Support 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` - -* container version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' 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` -`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` ## Versions -+ **26.01.19:** Fix continuation lines. -+ **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:** 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. diff --git a/readme-vars.yml b/readme-vars.yml index 3265a61..072a9b6 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -2,118 +2,73 @@ # project information project_name: sabnzbd -full_custom_readme: | - {% raw -%} - [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/ +project_url: "http://sabnzbd.org/" +project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sabnzbd-banner.png" +project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) 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." +project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}" +project_blurb_optional_extras_enabled: false - [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +# supported architectures +available_architectures: + - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"} + - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} + - { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"} - 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! +# development version +development_versions: true +development_versions_items: + - { tag: "latest", desc: "Stable SABnzbd releases" } + - { tag: "unstable", desc: "Beta/Stable SABnzbd releases at edge" } - # linuxserver/sabnzbd - [![](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/) +# container parameters +common_param_env_vars_enabled: true +param_container_name: "{{ project_name }}" +param_usage_include_net: false +param_usage_include_env: true +param_env_vars: + - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." } +param_usage_include_vols: true +param_volumes: + - { vol_path: "/config", vol_host_path: "", desc: "Local path for sabnzbd config files." } + - { vol_path: "/downloads", vol_host_path: "", desc: "Local path for finished downloads." } +param_usage_include_ports: true +param_ports: + - { external_port: "8080", internal_port: "8080", port_desc: "HTTP port for the WebUI." } + - { external_port: "9090", internal_port: "9090", port_desc: "HTTPS port for the WebUI." } +param_device_map: false +cap_add_param: false - 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. +# optional container parameters +opt_param_usage_include_env: false +opt_param_usage_include_vols: true +opt_param_volumes: + - { vol_path: "/incomplete-downloads", vol_host_path: "", desc: "Local path for incomplete-downloads." } +opt_param_usage_include_ports: false +opt_param_device_map: false +opt_cap_add_param: false +optional_block_1: false - [![sabnzbd](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sabnzbd-banner.png)][appurl] - - ## Usage - - ``` - docker create --name=sabnzbd \ - -v :/config \ - -v :/downloads \ - -v :/incomplete-downloads \ - -e PGID= -e PUID= \ - -e TZ= \ - -p 8080:8080 -p 9090:9090 \ - linuxserver/sabnzbd - ``` - - ## Tags - - You can choose ,using a tag, to use the unstable branch. - 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) - - Add the tag, if required, to the linuxserver/sabnzbd line of the run/create command in the following format:- - - `linuxserver/sabnzbd:unstable` - - ## 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.` - - - * `-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 - - It is based on ubuntu xenial with s6 overlay, for shell access whilst the container is running do `docker exec -it sabnzbd /bin/bash`. - - ### User / Group Identifiers - - 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" ™. - - In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: - - ``` - $ id - uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) - ``` - - ## Setting up the application +# application setup block +app_setup_block_enabled: true +app_setup_block: | 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` - - * 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:** Fix continuation lines. - + **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:** Intial Release. - {%- endraw %} +# changelog +changelogs: + - { date: "26.01.19:", desc: "Add pipeline logic and multi arch." } + - { date: "13.12.17:", desc: "Fix continuation lines." } + - { date: "12.07.17:", desc: "Add inspect commands to README, move to jenkins build and push." } + - { date: "10.04.17:", desc: "Bump to 2.0 Release." } + - { date: "25.02.17:", desc: "Switch to nobetas repo for master/latest branch and add unstable branch." } + - { date: "08.02.17:", desc: "Add pythonioenconding=utf8 as env." } + - { date: "15.09.16:", desc: "Compile par2 multicore as per latest info sabnzbd git [readme](https://github.com/sabnzbd/sabnzbd#resolving-dependencies)." } + - { date: "11.09.16:", desc: "Bump to release of 1.10." } + - { date: "09.09.16:", desc: "Rebase back to xenial, issues with alpine version of python and 1.10 branch of sab." } + - { date: "28.08.16:", desc: "Rebase to alpine, using git version of sab." } + - { date: "17.03.16:", desc: "Bump to install 1.0 final at startup." } + - { date: "14.03.16:", desc: "Refresh image to pick up latest RC." } + - { date: "23.01.15:", desc: "Refresh image." } + - { date: "14.12.15:", desc: "Refresh image to pick up latest beta." } + - { date: "21.08.15:", desc: "Initial Release." }