rogs/yams
rogs/yams
1
0
Fork 0
Code Issues 9 Pull Requests Actions Packages Projects Releases Wiki Activity

add configuration info to readme.org

Browse Source
This commit is contained in:
Lucy Randall 2025-03-19 16:32:37 -07:00
parent e53c7082cc
commit 6f0eaf6b7c
No known key found for this signature in database
GPG Key ID: 84814F6E6B61333C
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.org
View File

@ -92,7 +92,12 @@ Prepare the following:
- Default: ~/opt/yams~ - Default: ~/opt/yams~
- Ensure your user has write permissions - Ensure your user has write permissions
2. *Media Directory* 2. *Configuration Directory*
- Default: ~/opt/yams/config~
- Ensure your user has write permissions and there is
enough space for logs.
3. *Media Directory*
- Default: ~/srv/media~ - Default: ~/srv/media~
- Will contain subdirectories: - Will contain subdirectories:
+ ~/srv/media/tvshows~: TV series + ~/srv/media/tvshows~: TV series
@ -102,11 +107,11 @@ Prepare the following:
+ ~/srv/media/downloads~: Temporary download location + ~/srv/media/downloads~: Temporary download location
+ ~/srv/media/blackhole~: Watch folder for torrents + ~/srv/media/blackhole~: Watch folder for torrents
3. *Non-root User* 4. *Non-root User*
- Regular system user to own and manage files - Regular system user to own and manage files
- Must have sudo privileges for initial setup - Must have sudo privileges for initial setup
4. *VPN Service* (Optional but Recommended) 5. *VPN Service* (Optional but Recommended)
- Supported providers listed at [[https://yams.media/advanced/vpn#official-supported-vpns][yams.media/advanced/vpn]] - Supported providers listed at [[https://yams.media/advanced/vpn#official-supported-vpns][yams.media/advanced/vpn]]
- [[https://protonvpn.com/][ProtonVPN]] recommended for: - [[https://protonvpn.com/][ProtonVPN]] recommended for:
+ Simple configuration + Simple configuration