diff --git a/.github/ISSUE_TEMPLATE/issue.bug.yml b/.github/ISSUE_TEMPLATE/issue.bug.yml old mode 100755 new mode 100644 diff --git a/.github/ISSUE_TEMPLATE/issue.feature.yml b/.github/ISSUE_TEMPLATE/issue.feature.yml old mode 100755 new mode 100644 diff --git a/.github/workflows/call_issue_pr_tracker.yml b/.github/workflows/call_issue_pr_tracker.yml old mode 100755 new mode 100644 diff --git a/.github/workflows/call_issues_cron.yml b/.github/workflows/call_issues_cron.yml old mode 100755 new mode 100644 diff --git a/.github/workflows/permissions.yml b/.github/workflows/permissions.yml old mode 100755 new mode 100644 diff --git a/README.md b/README.md index b05c030..d1b10c7 100644 --- a/README.md +++ b/README.md @@ -71,14 +71,6 @@ This image provides various versions that are available via tags. Please read th Access the webui at `:8787`, for more information check out [Readarr](https://github.com/Readarr/Readarr). -### Media folders - -We have set `/books` and `/downloads` as ***optional paths***, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content. - -Use the optional paths if you don't understand, or don't want hardlinks/atomic moves. - -The 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. - ## Read-Only Operation This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/). @@ -87,6 +79,15 @@ This image can be run with a read-only container filesystem. For details please This image can be run with a non-root user. For details please [read the docs](https://docs.linuxserver.io/misc/non-root/). +### Media folders + +We have set /music and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content. + +Use the optional paths if you don't understand, or don't want hardlinks/atomic moves. + +>[!TIP] +>The 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. + ## Usage To help you get started creating a container from this image you can either use docker-compose or the docker cli. diff --git a/readme-vars.yml b/readme-vars.yml index 9258a00..b1a0433 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -34,14 +34,7 @@ nonroot_supported: true app_setup_block_enabled: true app_setup_block: | Access the webui at `:8787`, for more information check out [Readarr](https://github.com/Readarr/Readarr). - - ### Media folders - - We have set `/books` and `/downloads` as ***optional paths***, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content. - - Use the optional paths if you don't understand, or don't want hardlinks/atomic moves. - - The 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. +readme_media: true # init diagram init_diagram: | "readarr:develop": {