Browse Source

Fix readme

master
Matthew Faltys 7 years ago
parent
commit
963c906279
  1. 11
      readme.md

11
readme.md

@ -11,11 +11,12 @@ The quickest way to get going to by pulling the docker image from dockerhub. The
You will need (at minimum) a PIA credentials file that we will be linking into the container. This credentials file will allow openvpn to run in the background of the image so all information going in and out will be private. You will need (at minimum) a PIA credentials file that we will be linking into the container. This credentials file will allow openvpn to run in the background of the image so all information going in and out will be private.
#### Configuring #### Configuring
- **Credentials**: you will need to link in a credentials file (see below for the recommended run command) named `creds.x` into `/openvpn/` in the container. The formatting for the credentials file is simple, first line is the username, second is the password. Example: - **Credentials**: you will need to link in a credentials file (see below for the recommended run command) named `creds.x` into `/openvpn/` in the container. The formatting for the credentials file is simple, first line is the username, second is the password. Example:
``` ```
p1122334 p1122334
xyzPASSWORDxyz 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/`. - **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 #### Running

Loading…
Cancel
Save