Well planned paths

\n\nThe folks over at servarr.com wrote a good [write-up](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths) on how to get started with this.\n

\n\n## Read-Only Operation\n\nThis image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/).\n\n## Non-Root Operation\n\nThis image can be run with a non-root user. For details please [read the docs](https://docs.linuxserver.io/misc/non-root/).\n\n## Usage\n\nTo help you get started creating a container from this image you can either use docker-compose or the docker cli.\n\n>[!NOTE]\n>Unless a parameter is flagged as 'optional', it is *mandatory* and a value must be provided.\n\n### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))\n\n```yaml\n---\nservices:\n sabnzbd:\n image: lscr.io/linuxserver/sabnzbd:latest\n container_name: sabnzbd\n environment:\n - PUID=1000\n - PGID=1000\n - TZ=Etc/UTC\n volumes:\n - /path/to/sabnzbd/config:/config\n - /path/to/incomplete/downloads:/incomplete-downloads #optional\n - /path/to/downloads:/downloads #optional\n ports:\n - 8080:8080\n restart: unless-stopped\n```\n\n### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))\n\n```bash\ndocker run -d \\\n --name=sabnzbd \\\n -e PUID=1000 \\\n -e PGID=1000 \\\n -e TZ=Etc/UTC \\\n -p 8080:8080 \\\n -v /path/to/sabnzbd/config:/config \\\n -v /path/to/incomplete/downloads:/incomplete-downloads `#optional` \\\n -v /path/to/downloads:/downloads `#optional` \\\n --restart unless-stopped \\\n lscr.io/linuxserver/sabnzbd:latest\n```\n\n## Parameters\n\nContainers 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.\n\n| Parameter | Function |\n| :----: | --- |\n| `-p 8080:8080` | HTTP port for the WebUI. |\n| `-e PUID=1000` | for UserID - see below for explanation |\n| `-e PGID=1000` | for GroupID - see below for explanation |\n| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |\n| `-v /config` | Persistent config files |\n| `-v /incomplete-downloads` | Local path for incomplete-downloads. |\n| `-v /downloads` | Local path for finished downloads. |\n| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |\n| `--user=1000:1000` | Run container with a non-root user. Please [read the docs](https://docs.linuxserver.io/misc/non-root/). |\n\n## Environment variables from files (Docker secrets)\n\nYou can set any environment variable from a file by using a special prepend `FILE__`.\n\nAs an example:\n\n```bash\n-e FILE__MYVAR=/run/secrets/mysecretvariable\n```\n\nWill set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.\n\n## Umask for running applications\n\nFor all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.\nKeep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.\n\n## User / Group Identifiers\n\nWhen 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`.\n\nEnsure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.\n\nIn this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:\n\n```bash\nid your_user\n```\n\nExample output:\n\n```text\nuid=1000(your_user) gid=1000(your_user) groups=1000(your_user)\n```\n\n## Docker Mods\n\n[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=sabnzbd&query=%24.mods%5B%27sabnzbd%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=sabnzbd \"view available mods for this container.\") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal \"view available universal mods.\")\n\nWe publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.\n\n## Support Info\n\n* Shell access whilst the container is running:\n\n ```bash\n docker exec -it sabnzbd /bin/bash\n ```\n\n* To monitor the logs of the container in realtime:\n\n ```bash\n docker logs -f sabnzbd\n ```\n\n* Container version number:\n\n ```bash\n docker inspect -f '{{ index .Config.Labels \"build_version\" }}' sabnzbd\n ```\n\n* Image version number:\n\n ```bash\n docker inspect -f '{{ index .Config.Labels \"build_version\" }}' lscr.io/linuxserver/sabnzbd:latest\n ```\n\n## Updating Info\n\nMost of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), 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.\n\nBelow are the instructions for updating containers:\n\n### Via Docker Compose\n\n* Update images:\n * All images:\n\n ```bash\n docker-compose pull\n ```\n\n * Single image:\n\n ```bash\n docker-compose pull sabnzbd\n ```\n\n* Update containers:\n * All containers:\n\n ```bash\n docker-compose up -d\n ```\n\n * Single container:\n\n ```bash\n docker-compose up -d sabnzbd\n ```\n\n* You can also remove the old dangling images:\n\n ```bash\n docker image prune\n ```\n\n### Via Docker Run\n\n* Update the image:\n\n ```bash\n docker pull lscr.io/linuxserver/sabnzbd:latest\n ```\n\n* Stop the running container:\n\n ```bash\n docker stop sabnzbd\n ```\n\n* Delete the container:\n\n ```bash\n docker rm sabnzbd\n ```\n\n* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)\n* You can also remove the old dangling images:\n\n ```bash\n docker image prune\n ```\n\n### Image Update Notifications - Diun (Docker Image Update Notifier)\n\n>[!TIP]\n>We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.\n\n## Building locally\n\nIf you want to make local modifications to these images for development purposes or just to customize the logic:\n\n```bash\ngit clone https://github.com/linuxserver/docker-sabnzbd.git\ncd docker-sabnzbd\ndocker build \\\n --no-cache \\\n --pull \\\n -t lscr.io/linuxserver/sabnzbd:latest .\n```\n\nThe ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`\n\n```bash\ndocker run --rm --privileged lscr.io/linuxserver/qemu-static --reset\n```\n\nOnce registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.\n\n## Versions\n\n* **04.07.26:** - Rebase to Alpine 3.24\n* **28.12.25:** - Rebase to Alpine 3.23. Add RISCV build.\n* **05.07.25:** - Rebase to Alpine 3.22.\n* **23.12.24:** - Rebase to Alpine 3.21.\n* **31.05.24:** - Rebase to Alpine 3.20. Remove nzbnotify as apprise is now included with SABnzbd.\n* **23.12.23:** - Rebase to Alpine 3.19.\n* **23.11.23:** - Build translations.\n* **13.09.23:** - Use par2cmdline-turbo in place of par2cmdline.\n* **16.08.23:** - Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar).\n* **10.08.23:** - Bump unrar to 6.2.10.\n* **16.05.23:** - Rebase stable to Alpine 3.18, deprecate armhf.\n* **15.03.23:** - Switch from p7zip to 7zip, bump unrar to 6.2.6.\n* **05.03.23:** - Rebase master branch to Alpine 3.17.\n* **03.10.22:** - Rebase master branch to Alpine 3.16, migrate to s6v3.\n* **12.08.22:** - Bump unrar to 6.1.7.\n* **31.07.22:** - Add nightly tag.\n* **10.03.22:** - Add nzb-notify.\n* **22.02.22:** - Rebase master branch to Alpine, build unrar from source, deprecate Alpine branch.\n* **25.01.22:** - Rebase Unstable branch to Alpine.\n* **13.01.22:** - Add alpine branch\n* **08.08.21:** - Bump to focal, dont enforce binding to ipv4 port 8080\n* **24.07.21:** - Add python3-setuptools.\n* **14.05.21:** - Use linuxserver.io wheel index for pip packages.\n* **12.02.21:** - Clean up rust/cargo and pip cache.\n* **17.08.20:** - Run from source with python3 instead of ppa, remove python2 completely, symlink `python` to `python3`.\n* **02.01.20:** - Add python3 on top of python2 to image during transition.\n* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.\n* **25.02.19:** - Rebase to Bionic, add python deps for scripts.\n* **26.01.19:** - Add pipeline logic and multi arch.\n* **13.12.17:** - Fix continuation lines.\n* **12.07.17:** - Add inspect commands to README, move to jenkins build and push.\n* **10.04.17:** - Bump to 2.0 Release.\n* **25.02.17:** - Switch to nobetas repo for master/latest branch and add unstable branch.\n* **08.02.17:** - Add pythonioenconding=utf8 as env.\n* **15.09.16:** - Compile par2 multicore as per latest info sabnzbd git [readme](https://github.com/sabnzbd/sabnzbd#resolving-dependencies).\n* **11.09.16:** - Bump to release of 1.10.\n* **09.09.16:** - Rebase back to xenial, issues with alpine version of python and 1.10 branch of sab.\n* **28.08.16:** - Rebase to alpine, using git version of sab.\n* **17.03.16:** - Bump to install 1.0 final at startup.\n* **14.03.16:** - Refresh image to pick up latest RC.\n* **23.01.15:** - Refresh image.\n* **14.12.15:** - Refresh image to pick up latest beta.\n* **21.08.15:** - Initial Release.\n","has_starred","hub_user","immutable_tags_settings",{"_264":11,"_265":266},"enabled","rules",[267],".*","is_automated","permissions",{"_271":21,"_272":11,"_273":11},"read","write","admin","user","storage_size",314511354264,"isOrg","reponame","tag","sha256:cafe0c5d9693ab99c81f287271993e300d30283f8009ab6189aa622979870e3e","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_27":28,"_215":-7,"_213":-7,"_214":-7,"_29":289,"_35":280,"_293":-7,"_294":11},{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":290,"_67":68,"_69":34,"_70":71,"_72":73,"_74":75,"_76":77,"_78":50,"_79":68,"_80":59,"_81":21},[291,292],{"_44":45,"_35":46,"_47":48,"_49":50,"_51":52,"_53":54,"_55":48,"_56":-5,"_57":38,"_58":59,"_60":-5},{"_44":62,"_35":63,"_47":48,"_49":64,"_51":65,"_53":54,"_55":48,"_56":-5,"_57":66,"_58":59,"_60":-5},"imageWithLayers","hasPermissionToViewRepoSettings","actionData","errors"]

linuxserver/sabnzbd:version-5.1.3