diff --git a/readme.md b/readme.md index b9afd1e..e0c0b66 100644 --- a/readme.md +++ b/readme.md @@ -16,20 +16,20 @@ You will need (at minimum) a PIA credentials file that we will be linking into t xyzPASSWORDxyz ``` - **Config**: you can optionally supply an openvpn configuration file if you are using a VPN that support openvpn. Just place the configuration file (named `config.ovpn`) into the container at `/openvpn/`. -- **Running**: Here is an example of what to use when starting the container: - ``` - sudo docker run \ - -d \ - --name seedpod \ - --cap-add=NET_ADMIN \ - --cap-add=NET_RAW \ - --device=/dev/net/tun \ - --dns=8.8.8.8 \ - -p 9091:9091 \ - -v /home/user/transmission/downloads:/transmission/downloads:rw \ - -v /home/user/transmission/incomplete:/transmission/incomplete:rw \ - unixvoid/seedpod - ``` +- **Running**: Here is an example of what to use when starting the container: +``` +sudo docker run \ + -d \ + --name seedpod \ + --cap-add=NET_ADMIN \ + --cap-add=NET_RAW \ + --device=/dev/net/tun \ + --dns=8.8.8.8 \ + -p 9091:9091 \ + -v /home/user/transmission/downloads:/transmission/downloads:rw \ + -v /home/user/transmission/incomplete:/transmission/incomplete:rw \ + unixvoid/seedpod +``` Please note the use of `--cap-add=NET_ADMIN`, `--cap-add=NET_RAW`, `--device=/dev/net/tun`. These are needed by the image to create the VPN connection properly. Without these arguments the container will not be able to connect to the VPN. - **Accessing**: Once you have started the container is accessable on port 9091 with the following credentials: user: `admin`