Skip to content

Commit c510c26

Browse files
committed
Use media blurb
1 parent c6d5ca2 commit c510c26

File tree

7 files changed

+10
-16
lines changed

7 files changed

+10
-16
lines changed

.github/ISSUE_TEMPLATE/issue.bug.yml

100755100644
File mode changed.

.github/ISSUE_TEMPLATE/issue.feature.yml

100755100644
File mode changed.

.github/workflows/call_issue_pr_tracker.yml

100755100644
File mode changed.

.github/workflows/call_issues_cron.yml

100755100644
File mode changed.

.github/workflows/permissions.yml

100755100644
File mode changed.

README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,6 @@ This image provides various versions that are available via tags. Please read th
7171

7272
Access the webui at `<your-ip>:8787`, for more information check out [Readarr](https://github.com/Readarr/Readarr).
7373

74-
### Media folders
75-
76-
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.
77-
78-
Use the optional paths if you don't understand, or don't want hardlinks/atomic moves.
79-
80-
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.
81-
8274
## Read-Only Operation
8375

8476
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
8779

8880
This image can be run with a non-root user. For details please [read the docs](https://docs.linuxserver.io/misc/non-root/).
8981

82+
### Media folders
83+
84+
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.
85+
86+
Use the optional paths if you don't understand, or don't want hardlinks/atomic moves.
87+
88+
>[!TIP]
89+
>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.
90+
9091
## Usage
9192

9293
To help you get started creating a container from this image you can either use docker-compose or the docker cli.

readme-vars.yml

+1-8
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,7 @@ nonroot_supported: true
3434
app_setup_block_enabled: true
3535
app_setup_block: |
3636
Access the webui at `<your-ip>:8787`, for more information check out [Readarr](https://github.com/Readarr/Readarr).
37-
38-
### Media folders
39-
40-
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.
41-
42-
Use the optional paths if you don't understand, or don't want hardlinks/atomic moves.
43-
44-
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.
37+
readme_media: true
4538
# init diagram
4639
init_diagram: |
4740
"readarr:develop": {

0 commit comments

Comments
 (0)