Skip to content

Commit

Permalink
Updated README for usage
Browse files Browse the repository at this point in the history
  • Loading branch information
kizzx2 committed Feb 26, 2016
1 parent 09acbed commit 10e3924
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,21 @@ This is a docker image of an OpenVPN client tied to a SOCKS proxy server. It is
useful to isolate network changes (so the host is not affected by the modified
routing).

This supports directory style (where the certificates are not bundled together in one `.ovpn` file) and those that contains `update-resolv-conf`

## Usage

Preferably, using `start` in this repository:
```bash
start client_config.ovpn
start /your/openvpn/directory
```

`/your/openvpn/directory` should contain *one* OpenVPN `.conf` file. It can reference other certificate files or key files in the same directory.

Alternatively, using `docker run` directly:

```bash
docker run -t -i --device=/dev/net/tun --cap-add=NET_ADMIN \
--volume client_config.ovpn:/ovpn.conf:ro \
mook/openvpn-client-socks
docker run -it --device=/dev/net/tun --cap-add=NET_ADMIN \
--volume /your/openvpn/directory/:/etc/openvpn/:ro \
kizzx2/openvpn-client-socks
```

### OpenVPN Configuration Constraints

- The configuration file must have embedded certificates; references to other
files are not allowed.
- The configuration file must use `dev tun0`.

0 comments on commit 10e3924

Please sign in to comment.