From 01b59eea70cd632b35b7410d0ece4c9b2b24c0bd Mon Sep 17 00:00:00 2001 From: Jelle Meeus Date: Tue, 24 Dec 2024 12:53:22 +0100 Subject: [PATCH] docs: add podman --- .github/README.md | 64 +++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 54 insertions(+), 10 deletions(-) diff --git a/.github/README.md b/.github/README.md index 6bb65dc..1f45050 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,16 +1,21 @@ # Home Media Server + `docker-compose.yml` setup for a comprehensive home media server stack. Seamlessly manage and access your content, including movies, TV shows, music, and eBooks + Kobo eReader sync. Featuring apps like Plex, Transmission, Prowlarr, Radarr, Sonarr, Lidarr, Calibre, and Filebrowser, this server empowers you to enjoy and organize your media collection with ease. You have two configuration options: + 1. Without VPN (`*-novpn.yml`): For straightforward local use. 1. With VPN (`*-vpn.yml`): Enhances privacy and secures your P2P traffic via OpenVPN Optional Stacks: -* Traefik: Simplifies service management by providing a reverse proxy with easy-to-configure, accessible URLs for all services. -* Organizr: Acts as a unified front-end dashboard to access and organize all your services in one convenient place. + +- Traefik: Simplifies service management by providing a reverse proxy with easy-to-configure, accessible URLs for all services. +- Organizr: Acts as a unified front-end dashboard to access and organize all your services in one convenient place. ## VPN or no VPN + Choosing whether to use a VPN is entirely up to you. Here’s the key difference: + - **Without VPN**: Your P2P and Soulseek traffic will route directly through your internet connection, which is simple to set up but offers no additional privacy. - **With VPN**: Routes all P2P and Soulseek traffic through OpenVPN, providing enhanced privacy, encryption, and security. This is entirely **separate** from your normal internet traffic. This setup is highly recommended if you value anonymity @@ -22,15 +27,15 @@ Choosing the VPN setup requires a few additional steps. Here’s what you need: If you already have a VPN that supports P2P, you can skip this paragraph. If not, consider a reliable provider. I recommend **ProtonVPN** (tested and pre-configured with this setup) or alternatives like **Surfshark** and **Windscribe**. - ## Services and their use + | Images | Use | | ------------------------ | ----------------------------------- | | transmission (+ openvpn) | downloads | | prowlarr | indexer manager | | calibre | books library manager | | calibre-web | books library to enable Kobo Sync | -| openbooks (*) | books finder | +| openbooks (\*) | books finder | | radarr | movies | | lidarr | music | | sonarr | tv | @@ -42,7 +47,9 @@ If you already have a VPN that supports P2P, you can skip this paragraph. If not ``` (*) Alternative: Library Genesis (Libgen) ``` -## Folder structure + +## Folder structure + ``` / ├── appdata @@ -75,7 +82,10 @@ If you already have a VPN that supports P2P, you can skip this paragraph. If not # Deploying the stack +This section covers deployment options for your home media server stack. You can choose to deploy using Portainer, Docker Compose with Docker Desktop, or Podman. Each method has its own advantages, but for simplicity and ease of use, we recommend using Portainer. + ## Using portainer + copypaste `docker-compose*.yml` to portainer config and add `home-media-server*.env` to portainer @@ -83,6 +93,7 @@ config and add `home-media-server*.env` to portainer launch stack ## Docker desktop + Make sure file sharing is enabled for the directories you are mapping. ``` @@ -90,17 +101,31 @@ setup settings -> resources -> file sharing ``` Then you can setup a folder so that: + ``` . ├── docker-compose.yml └── stack.env +$ docker compose --env-file stack.env up --detach ``` -then run + +## Podman desktop + +Similarly to Docker desktop setup, use Podman with the Compose Engine + +https://podman-desktop.io/docs/compose/running-compose +https://podman-desktop.io/docs/compose/setting-up-compose +"/usr/local/bin" added to `$PATH` + ``` -docker compose up +. +├── docker-compose.yml +└── stack.env +$ podman compose --env-file stack.env up --detach ``` # Config + After launching for the first time, some configuration is required. Always refer to the official docs. Some pointers are listed per application Config through web by going to `http://0.0.0.0:{port}/` @@ -121,11 +146,13 @@ Config through web by going to `http://0.0.0.0:{port}/` | 9983 | organizr | organizr.domain.duckdns.org | o | ## Transmission + Use environment variables to configure refer to: https://github.com/transmission/transmission/blob/main/docs/Editing-Configuration-Files.md for example some bandwidth envs are setup by default: + ``` Bandwidth @@ -137,32 +164,39 @@ Bandwidth ``` ### VPN Configuration + If using ProtonVPN, you can skip the OpenVPN configuration files and you only need to obtain your credentials. These are obtained through the web interface under sidebar option `Account` -> `OpenVPN / IKEv2 username and password`. These will be your `OPENVPN_USERNAME` and `OPENVPN_PASSWORD` respectively. Direct link to ProtonVPN docs http://haugene.github.io/docker-transmission-openvpn/provider-specific/#protonvpn For other providers, the docs can be found at http://haugene.github.io/docker-transmission-openvpn/ ## Prowlarr + https://docs.prowler.com/projects/prowler-open-source/en/latest/ ## Sonarr, radarr, lidarr + These services require you to setup an indexer (prowlarr) and a download client (transmission) 1. Add indexers to apps -copy the API key from the app then add the app in the Prowlarr web interface + copy the API key from the app then add the app in the Prowlarr web interface 2. Add download client + ``` Transmission client Add category {tv|music|movies|books} ``` + ## Calibre, calibre-web + default login calibre: `abc abc` default login calibre-web: `admin admin123` Use calibre to add books, calibre-web to setup a store endpoint to enable Kobo Sync ### Setup eReader with Kobo sync and calibre-web + documentation: https://github.com/janeczku/calibre-web/wiki/Kobo-Integration Note that the following is written and tested for a `Kobo Aura H2O` model, steps may be different or this might not work at all for any other models. @@ -170,6 +204,7 @@ Under abc's Profile (default profile) "Kobo Sync Token" click "create/view token" This feature might need to be enabled by default + > Enable Kobo sync checkbox in the Basic configuration >> Feature > Configuration page. @@ -184,15 +219,19 @@ Next connect eReader with a usb-cable to your computer. A single line in a confi > Create/View button under their Calibre-Web profile page. You need to change the ip to your local ip address, for example: + ``` api_endpoint=http://192.168.0.205:8083/kobo/0cf8e8ccb456ad872f781f88b2cfdf83 ``` #### Troubleshooting + books aren't updating? Test with + ``` http://localhost:8083/calibreweb/kobo/{token}/v1/library/sync ``` + Go the api_endpoint in browser. If this is empty, consider pressing "Force full kobo sync" in the user options in calibre-web ## Filebrowser @@ -201,7 +240,7 @@ Go the api_endpoint in browser. If this is empty, consider pressing "Force full Mounts a single folder called Filebrowser to /srv. This folder must be empty. - Other folders are mounted as such: /srv/Pictures +Other folders are mounted as such: /srv/Pictures so they are accessible in the container as /Pictures This will create Pictures/ under Applications. Pictures/ will be empty @@ -210,6 +249,7 @@ filebrowser.db must exist before mounting, else mounts a directory `touch filebrowser.db` same with settings.json + ``` ❯ cat settings.json { @@ -225,12 +265,15 @@ same with settings.json admin/admin on initial login :8090 ## Soulseek + setup Share folder(s) by clicking "Share Folder" at the very top of interface ## Openbooks + documentation: https://evan-buss.github.io/openbooks/setup/docker/ Books are downloaded through the browser. They need to be manually added to calibre's library: + - Move downloaded file to `/books_add_me` folder. This is mapped in the compose file (`.yml`) file - open calibre and click the `Add books` button. This copies the file to the library. - The downloaded file can be removed @@ -238,11 +281,12 @@ Books are downloaded through the browser. They need to be manually added to cali The library will automaticly synchronize with `calibre web` and can then be synced to your ereader. Periodic syncing should be enabled by default on your ereader. ## Organizr + documentation: https://docs.organizr.app/ https://github.com/causefx/Organizr # Credits + Inspired by Youtube tutorial of a similar setup [Easy Automated Home Media Server: VPN, Radarr, Sonarr, Lidarr, Librarian in 10 Minutes.](https://www.youtube.com/watch?v=5rtGBwBuzQE) The traefik reverse proxy setup is adapted from "Traefik 3 Docker Certificates Guide" by [TechnoTim](https://github.com/timothystewart6), originally published at https://technotim.live/posts/traefik-3-docker-certificates/, and licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Changes were made to customize the configuration for use with DuckDNS instead of Cloudflare and routing services. -