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 sonarr:\n image: lscr.io/linuxserver/sonarr:latest\n container_name: sonarr\n environment:\n - PUID=1000\n - PGID=1000\n - TZ=Etc/UTC\n volumes:\n - /path/to/sonarr/data:/config\n - /path/to/tvseries:/tv #optional\n - /path/to/downloadclient-downloads:/downloads #optional\n ports:\n - 8989:8989\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=sonarr \\\n -e PUID=1000 \\\n -e PGID=1000 \\\n -e TZ=Etc/UTC \\\n -p 8989:8989 \\\n -v /path/to/sonarr/data:/config \\\n -v /path/to/tvseries:/tv `#optional` \\\n -v /path/to/downloadclient-downloads:/downloads `#optional` \\\n --restart unless-stopped \\\n lscr.io/linuxserver/sonarr: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 8989:8989` | The port for the Sonarr web interface |\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` | Database and sonarr configs |\n| `-v /tv` | Location of TV library on disk (See note in Application setup) |\n| `-v /downloads` | Location of download managers output directory (See note in Application setup) |\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=sonarr&query=%24.mods%5B%27sonarr%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=sonarr \"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 sonarr /bin/bash\n ```\n\n* To monitor the logs of the container in realtime:\n\n ```bash\n docker logs -f sonarr\n ```\n\n* Container version number:\n\n ```bash\n docker inspect -f '{{ index .Config.Labels \"build_version\" }}' sonarr\n ```\n\n* Image version number:\n\n ```bash\n docker inspect -f '{{ index .Config.Labels \"build_version\" }}' lscr.io/linuxserver/sonarr: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 sonarr\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 sonarr\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/sonarr:latest\n ```\n\n* Stop the running container:\n\n ```bash\n docker stop sonarr\n ```\n\n* Delete the container:\n\n ```bash\n docker rm sonarr\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-sonarr.git\ncd docker-sonarr\ndocker build \\\n --no-cache \\\n --pull \\\n -t lscr.io/linuxserver/sonarr: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* **12.10.26:** - Update `develop` branch to v5. New v5 installs will write initial credentials to container log.\n* **09.07.26:** - Workaround malformed ncurses database.\n* **04.07.26:** - Rebase to Alpine 3.24.\n* **15.01.26:** - Rebase to Alpine 3.23.\n* **05.07.25:** - Rebase to Alpine 3.22.\n* **09.01.25:** - Fix rootless entrypoint.\n* **23.12.24:** - Rebase Alpine 3.21.\n* **31.05.24:** - Rebase Alpine 3.20.\n* **12.01.24:** - Update download url.\n* **30.12.23:** - Rebase master branch to Alpine 3.19.\n* **15.02.23:** - Rebase master branch to Jammy.\n* **19.12.22:** - Rebase develop branch Alpine 3.17.\n* **24.11.22:** - Bump develop branch to v4, rebase to Alpine 3.16.\n* **03.08.22:** - Deprecate armhf.\n* **02.08.22:** - Add armhf deprecation warning.\n* **28.04.22:** - Rebase master branch to mono 6.12 base (focal).\n* **20.02.22:** - Rebase develop branch to Alpine, deprecate develop-alpine branch.\n* **28.12.21:** - Add develop-alpine branch.\n* **11.05.21:** - Make the paths clearer to the user.\n* **10.03.21:** - Upgrade to Sonarr v3. Existing users are highly recommended to make a backup prior to update.\n* **18.01.21:** - Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information.\n* **05.04.20:** - Move app to /app.\n* **01.08.19:** - Rebase to Linuxserver LTS mono version.\n* **13.06.19:** - Add env variable for setting umask.\n* **10.05.19:** - Rebase to Bionic.\n* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.\n* **01.02.19:** - Multi arch images and pipeline build logic\n* **15.12.17:** - Fix continuation lines.\n* **12.07.17:** - Add inspect commands to README, move to jenkins build and push.\n* **17.04.17:** - Switch to using inhouse mono baseimage, adds python also.\n* **14.04.17:** - Change to mount /etc/localtime in README, thanks cbgj.\n* **13.04.17:** - Switch to official mono repository.\n* **30.09.16:** - Fix umask\n* **23.09.16:** - Add cd to /opt fixes redirects with althub (issue #25), make XDG config environment variable\n* **15.09.16:** - Add libcurl3 package.\n* **09.09.16:** - Add layer badges to README.\n* **27.08.16:** - Add badges to README.\n* **20.07.16:** - Rebase to xenial.\n* **31.08.15:** - Cleanup, changed sources to fetch binarys from. also a new baseimage.\n","has_starred","hub_user","immutable_tags_settings",{"_251":11,"_252":253},"enabled","rules",[254],".*","is_automated","permissions",{"_258":21,"_259":11,"_260":11},"read","write","admin","user","storage_size",341645997465,"isOrg","reponame","tag","sha256:d9551b7b6f52cb21ab160bfdf4e0f750fc5891d23d0d387c717c851ca6f9da7e","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_27":28,"_209":-7,"_207":-7,"_208":-7,"_29":276,"_35":267,"_280":-7,"_281":11},{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":277,"_67":68,"_69":34,"_70":71,"_72":73,"_74":75,"_76":77,"_78":64,"_79":68,"_80":59,"_81":21},[278,279],{"_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/sonarr:4.0.20