master-group/charts
2
0
Fork 0
mirror of https://github.com/k8s-at-home/charts.git synced 2025-01-23 15:39:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation for rtorrent-flood (#412)

Browse Source 
Co-authored-by: pierre <pierre.d@comet.co>
Co-authored-by: Jeff Billimek <jeff@billimek.com>
This commit is contained in:
Pierre D 2021-01-26 08:19:17 +01:00 committed by GitHub
parent fc49382e94
commit efcde7f81b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
charts/rtorrent-flood/README.md
View File

@ -1,3 +1,27 @@
# rTorrent/flood BitTorrent client
TBD
## Setup
NB: This chart will start 2 containers in a single pod, when both containers are started, you will be able to configure flood.
1. Install the chart `helm install rtorrent k8s-at-home/rtorrent-flood`
2. Port-forward to the container `kubectl port-forward $(kubectl get pods -A -o json | jq '.items[] | select(.metadata.labels."app.kubernetes.io/name"=="rtorrent-flood")' | jq .metadata.name -r) 3000:3000`
3. To connect flood to rtorrent, provide the socket path : `/tmp/rtorrent.sock`
4. When connected with flood to rtorrent, go to the settings and change the download path to `/data` which is set by default by the chart
5. You should be able to start downloading torrents now :)
## Custom parameters
Like any other chart, you can provide a file with your own values (check `./values.yaml` for reference) :
`helm install rtorrent k8s-at-home/rtorrent-flood -f my-values.yaml`
## Pitfalls
You may need to change the StorageClass depending on your kubernetes setup or the containers won't start, use a custom `values.yaml` file to do so.