Update README.md

Update readme to include jellyseer as well as vpn links
This commit is contained in:
J 2023-05-25 13:39:31 -04:00 committed by GitHub
parent 4aae90c78e
commit a93f2a0a9b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,7 +10,7 @@ I am running it in Ubuntu Server 22.04; I also tested this setup on a [Synology
![Docker-Compose NAS Homepage](https://github.com/AdrienPoupa/docker-compose-nas/assets/15086425/3492a9f6-3779-49a5-b052-4193844f16f0) ![Docker-Compose NAS Homepage](https://github.com/AdrienPoupa/docker-compose-nas/assets/15086425/3492a9f6-3779-49a5-b052-4193844f16f0)
## Table of Content ## Table of Contents
<!-- TOC --> <!-- TOC -->
* [Docker Compose NAS](#docker-compose-nas) * [Docker Compose NAS](#docker-compose-nas)
@ -26,6 +26,7 @@ I am running it in Ubuntu Server 22.04; I also tested this setup on a [Synology
* [qBittorrent](#qbittorrent) * [qBittorrent](#qbittorrent)
* [Jellyfin](#jellyfin) * [Jellyfin](#jellyfin)
* [Homepage](#homepage) * [Homepage](#homepage)
* [Jellyseerr](#jellyseerr)
* [Traefik and SSL Certificates](#traefik-and-ssl-certificates) * [Traefik and SSL Certificates](#traefik-and-ssl-certificates)
* [Accessing from the outside with Tailscale](#accessing-from-the-outside-with-tailscale) * [Accessing from the outside with Tailscale](#accessing-from-the-outside-with-tailscale)
* [Optional Services](#optional-services) * [Optional Services](#optional-services)
@ -89,7 +90,7 @@ If you want to show Jellyfin information in the homepage, create it in Jellyfin
| `TIMEZONE` | TimeZone used by the container. | `America/New_York` | | `TIMEZONE` | TimeZone used by the container. | `America/New_York` |
| `DATA_ROOT` | Host location of the data files | `/mnt/data` | | `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` | | `DOWNLOAD_ROOT` | Host download location for qBittorrent, should be a subfolder of `DATA_ROOT` | `/mnt/data/torrents` |
| `PIA_LOCATION` | Servers to use for PIA | `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_USER` | PIA username | |
| `PIA_PASS` | PIA password | | | `PIA_PASS` | PIA password | |
| `PIA_LOCAL_NETWORK` | PIA local network | `192.168.0.0/16` | | `PIA_LOCAL_NETWORK` | PIA local network | `192.168.0.0/16` |
@ -208,6 +209,10 @@ Due to how the Docker socket is configured for the Docker integration, files mus
The files in `/homepage/tpl/*.yaml` only serve as a base to set up the homepage configuration on first run. The files in `/homepage/tpl/*.yaml` only serve as a base to set up the homepage configuration on first run.
## Jellyseerr
Jellyseer gives you content reccomendations, allows others to make requests to you, and allows logging in with jellyfin credentials.
## Traefik and SSL Certificates ## Traefik and SSL Certificates
While you can use the private IP to access your NAS, how cool would it be for it to be accessible through a subdomain While you can use the private IP to access your NAS, how cool would it be for it to be accessible through a subdomain