From 7400616dcd3885d9af26dd6a7e7669686c735f5d Mon Sep 17 00:00:00 2001 From: Adrien Poupa Date: Sun, 28 May 2023 12:14:09 -0400 Subject: [PATCH] doc: add documentation for Jellyseer --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4832b41..4d05270 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ I am running it in Ubuntu Server 22.04; I also tested this setup on a [Synology * [Docker Compose NAS](#docker-compose-nas) - * [Table of Content](#table-of-content) + * [Table of Contents](#table-of-contents) * [Applications](#applications) * [Quick Start](#quick-start) * [Environment Variables](#environment-variables) @@ -59,6 +59,7 @@ I am running it in Ubuntu Server 22.04; I also tested this setup on a [Synology | [PIA WireGuard VPN](https://github.com/thrnz/docker-wireguard-pia) | Encapsulate qBittorrent traffic in [PIA](https://www.privateinternetaccess.com/) using [WireGuard](https://www.wireguard.com/) with port forwarding. | [thrnz/docker-wireguard-pia](https://hub.docker.com/r/thrnz/docker-wireguard-pia) | | | [qBittorrent](https://www.qbittorrent.org) | Bittorrent client with a complete web UI
Uses VPN network
Using Libtorrent 1.x | [linuxserver/qbittorrent:libtorrentv1](https://hub.docker.com/r/linuxserver/qbittorrent) | /qbittorrent | | [Jellyfin](https://jellyfin.org) | Media server designed to organize, manage, and share digital media files to networked devices | [linuxserver/jellyfin](https://hub.docker.com/r/linuxserver/jellyfin) | /jellyfin | +| [Jellyseer](https://jellyfin.org) | Manages requests for your media library | [fallenbagel/jellyseerr](https://hub.docker.com/r/fallenbagel/jellyseerr) | /jellyseer | | [Homepage](https://gethomepage.dev) | Application dashboard | [benphelps/homepage](https://github.com/benphelps/homepage/pkgs/container/homepage) | / | | [Traefik](https://traefik.io) | Reverse proxy | [traefik](https://hub.docker.com/_/traefik) | | | [Watchtower](https://containrrr.dev/watchtower/) | Automated Docker images update | [containrrr/watchtower](https://hub.docker.com/r/containrrr/watchtower) | | @@ -90,7 +91,7 @@ If you want to show Jellyfin information in the homepage, create it in Jellyfin | `TIMEZONE` | TimeZone used by the container. | `America/New_York` | | `DATA_ROOT` | Host location of the data files | `/mnt/data` | | `DOWNLOAD_ROOT` | Host download location for qBittorrent, should be a subfolder of `DATA_ROOT` | `/mnt/data/torrents` | -| `PIA_LOCATION` | Servers to use for PIA. [see list here](https://serverlist.piaservers.net/vpninfo/servers/v6) | `ca` (Montreal, Canada) | +| `PIA_LOCATION` | Servers to use for PIA. [see list here](https://serverlist.piaservers.net/vpninfo/servers/v6) | `ca` (Montreal, Canada) | | `PIA_USER` | PIA username | | | `PIA_PASS` | PIA password | | | `PIA_LOCAL_NETWORK` | PIA local network | `192.168.0.0/16` | @@ -98,6 +99,8 @@ If you want to show Jellyfin information in the homepage, create it in Jellyfin | `ADGUARD_HOSTNAME` | Optional - AdGuard Home hostname used, if enabled | | | `ADGUARD_USERNAME` | Optional - AdGuard Home username to show details in the homepage, if enabled | | | `ADGUARD_PASSWORD` | Optional - AdGuard Home password to show details in the homepage, if enabled | | +| `QBITTORRENT_USERNAME` | qBittorrent username to access the web UI | `admin` | +| `QBITTORRENT_PASSWORD` | qBittorrent password to access the web UI | `adminadmin` | | `DNS_CHALLENGE` | Enable/Disable DNS01 challenge, set to `false` to disable. | `true` | | `DNS_CHALLENGE_PROVIDER` | Provider for DNS01 challenge, [see list here](https://doc.traefik.io/traefik/https/acme/#providers). | `cloudflare` | | `LETS_ENCRYPT_CA_SERVER` | Let's Encrypt CA Server used to generate certificates, set to production by default.
Set to `https://acme-staging-v02.api.letsencrypt.org/directory` to test your changes with the staging server. | `https://acme-v02.api.letsencrypt.org/directory` | @@ -109,6 +112,7 @@ If you want to show Jellyfin information in the homepage, create it in Jellyfin | `RADARR_API_KEY` | Radarr API key to show information in the homepage | | | `PROWLARR_API_KEY` | Prowlarr API key to show information in the homepage | | | `JELLYFIN_API_KEY` | Jellyfin API key to show information in the homepage | | +| `JELLYSEERR_API_KEY` | Jellyseer API key to show information in the homepage | | | `HOMEPAGE_VAR_TITLE` | Title of the homepage | `Docker-Compose NAS` | | `HOMEPAGE_VAR_SEARCH_PROVIDER` | Homepage search provider, [see list here](https://gethomepage.dev/en/widgets/search/) | `google` | | `HOMEPAGE_VAR_HEADER_STYLE` | Homepage header style, [see list here](https://gethomepage.dev/en/configs/settings/#header-style) | `boxed` |