diff --git a/readme.md b/readme.md index e0c0b66..4647b06 100644 --- a/readme.md +++ b/readme.md @@ -16,7 +16,8 @@ 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: + +### Running ``` sudo docker run \ -d \ @@ -31,9 +32,11 @@ sudo docker run \ 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` - pass: `password` + +### Accessing +Once you have started the container is accessable on port 9091 with the following credentials: +- user: `admin` +- pass: `password` ## Building from source - **Config**: place your config in `deps/` full path to the file will be `deps/config.ovpn`. the default openvpn configuration file is set up to use us-midwest in PIA