Navy.gif/media-stack
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: #40 update README.md to reflect latest qBittorrent changes

Browse Source
This commit is contained in:
Adrien Poupa 2023-12-18 23:36:37 -05:00
parent b9418c94ff
commit 0be022cc16
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.env.example
View File

@ -14,7 +14,7 @@ ADGUARD_HOSTNAME=
ADGUARD_USERNAME= ADGUARD_USERNAME=
ADGUARD_PASSWORD= ADGUARD_PASSWORD=
QBITTORRENT_USERNAME=admin QBITTORRENT_USERNAME=admin
QBITTORRENT_PASSWORD=adminadmin QBITTORRENT_PASSWORD=
DNS_CHALLENGE=true DNS_CHALLENGE=true
DNS_CHALLENGE_PROVIDER=cloudflare DNS_CHALLENGE_PROVIDER=cloudflare
LETS_ENCRYPT_CA_SERVER="https://acme-v02.api.letsencrypt.org/directory" LETS_ENCRYPT_CA_SERVER="https://acme-v02.api.letsencrypt.org/directory"

17
README.md
View File

@ -81,6 +81,8 @@ see [Optional Services](#optional-services) for more information.
For the first time, run `./update-config.sh` to update the applications base URLs and set the API keys in `.env`. For the first time, run `./update-config.sh` to update the applications base URLs and set the API keys in `.env`.
Get your qBittorrent password from `docker compose logs qbittorrent` and change it in the UI and in `.env.`
If you want to show Jellyfin information in the homepage, create it in Jellyfin settings and fill `JELLYFIN_API_KEY`. If you want to show Jellyfin information in the homepage, create it in Jellyfin settings and fill `JELLYFIN_API_KEY`.
## Environment Variables ## Environment Variables
@ -103,7 +105,7 @@ If you want to show Jellyfin information in the homepage, create it in Jellyfin
| `ADGUARD_USERNAME` | Optional - AdGuard Home username to show details in the homepage, 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 | | | `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_USERNAME` | qBittorrent username to access the web UI | `admin` |
| `QBITTORRENT_PASSWORD` | qBittorrent password to access the web UI | `adminadmin` | | `QBITTORRENT_PASSWORD` | qBittorrent password to access the web UI | None, please set your password |
| `DNS_CHALLENGE` | Enable/Disable DNS01 challenge, set to `false` to disable. | `true` | | `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` | | `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.<br/>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` | | `LETS_ENCRYPT_CA_SERVER` | Let's Encrypt CA Server used to generate certificates, set to production by default.<br/>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` |
@ -186,9 +188,16 @@ Their API keys can be found in Settings > Security > API Key.
## qBittorrent ## qBittorrent
Set the default save path to `/data/torrents` in Settings, and restrict the network interface to WireGuard (`wg0`). Since qBittorrent v4.6.2, a temporary password is generated on startup. Get it with `docker compose logs qbittorrent`:
```
The WebUI administrator username is: admin
The WebUI administrator password was not set. A temporary password is provided for this session: <some_password>
```
The web UI login page can be disabled on for the local network in Settings > Web UI > Bypass authentication for clients Use this password to access the UI, then go to Settings > Web UI and set your own password,
then set it in `.env`'s `QBITTORRENT_PASSWORD` variable.
The login page can be disabled on for the local network in by enabling `Bypass authentication for clients`.
``` ```
192.168.0.0/16 192.168.0.0/16
@ -196,6 +205,8 @@ The web UI login page can be disabled on for the local network in Settings > Web
172.17.0.0/16 172.17.0.0/16
``` ```
Set the default save path to `/data/torrents` in Settings, and restrict the network interface to WireGuard (`wg0`).
## Jellyfin ## Jellyfin
To enable [hardware transcoding](https://jellyfin.org/docs/general/administration/hardware-acceleration/), To enable [hardware transcoding](https://jellyfin.org/docs/general/administration/hardware-acceleration/),