Added readme
This commit is contained in:
parent
fe844b9d04
commit
1026f97487
1 changed files with 19 additions and 0 deletions
19
README.md
Normal file
19
README.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# Kubernetes *Arr stack
|
||||
|
||||
Almost everything you need to run an *Arr stack in kubernetes
|
||||
|
||||
## Configuration
|
||||
|
||||
There is some configuration required. Mainly setting the URLs for some services in the `Ingress.yml` files, and setting the download and media folder paths in some `Deployment.yml` files. It is currently set up so paths on the host are mounted in the pods, but you can easily use a couple of `PersistentVolumeClaim`s set to `ReadWriteMany` to allow multiple pods to write to them at a time.
|
||||
|
||||
## VPN stuff
|
||||
|
||||
Included is PrivoxyVPN to be used with Prowlarr and QBitTorrent which also comes bundled with an OpenVPN container. These will both need to be set up with ovpn files (though the PrivoxyVPN deployment can be reconfigured to use WireGuard). If you wish to use WireGuard for both, you can either replace the OpenVPN container in the QBitTorrent deployment with a WireGuard one, or remove it entirely and configure QBitTorrent to use the PrivoxyVPN, and configure that to use WireGuard
|
||||
|
||||
## Pointing stuff at other stuff
|
||||
|
||||
Once it is deployed and working, you will need to manually configure each service to point to the relevant other services (e.g. pointing sonarr & radarr to QBitTorrent)
|
||||
|
||||
## This readme isn't very good
|
||||
|
||||
If you have any questions, feel free to send me a message on matrix `@foxgirlriley:linuxposting.xyz`
|
||||
Loading…
Add table
Add a link
Reference in a new issue