Update README

charts/qbittorrent-gluetun/README.md

@@ -2,11 +2,9 @@
 
 A Helm chart for deploying a QBittorrent client that uses a VPN tunnel provided by Gluetun.
 
-### Installation via Helm
+### Installation
 
-TODO
-
-### Define a secret for VPN credentials
+#### Define a secret for VPN credentials
 
 ```
 kubectl create secret generic vpn-credentials \
@@ -15,12 +13,60 @@ kubectl create secret generic vpn-credentials \
   --namespace=default
 ```
 
+#### Helm
+
+1. Add the Helm chart repo
+
+```bash
+helm repo add k8s-charts https://kriegalex.github.io/k8s-charts/
+```
+
+2. Inspect & modify the default values (optional)
+
+```bash
+helm show values k8s-charts/qbittorrent-gluetun > values.yaml
+```
+
+3. Install the chart
+
+```bash
+helm upgrade --install qbit k8s-charts/qbittorrent-gluetun --values values.yaml
+```
+
 ### QBittorrent login
 
-The login is `admin`. The password is visible in the logs of the qbittorent app:
+The login is `admin`. The password is visible in the logs of the qbittorent app the first time you start it:
+
+```
+kubectl logs POD_NAME qbittorrent
+```
+
+Replace POD_NAME by the name of your pod (`kubectl get pods`). The two arguments are required because this pod runs two apps.
+
+### Gluetun Port Forwarding
+
+You can get the port obtained from PIA by:
+
+1. Looking at the gluetun app logs
 
+```console
+kubectl logs POD_NAME gluetun
 ```
-kubectl logs qbittorrent-gluetun-RELEASE-UNIQ qbittorrent
+
+2. Check the JSON file in the config persistent volume of your app "gluetun"
+
+In my case, the PV for the config persistent volume of gluetun comes from a NFS share on a remote server (storageClass: "nfs-client").
+
+```console
+ssh USER@NFS_SERVER
+cat /NFS_PATH/config/FILE.json
+```
+
+3. Connect to the container directly
+
+```console
+kubectl exec --stdin --tty POD_NAME -c gluetun -- /bin/sh
+ls /gluetun/
 ```
 
-Replace RELEASE-UNIQ by the name of your pod.
+The `-c` is required because this pod runs two apps.