summaryrefslogtreecommitdiff
path: root/images/obfsvpn/README.md
blob: 5338513c5a27f8f197a8f12acbde7790ca6d0864 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
## Dockerized obfs4 and openvpn in a single container

This is based on the [dockovpn/docker-openvpn](https://github.com/dockovpn/docker-openvpn) repository, it adds the `obfsvpn-server`
binary and the required config files to start an instance of the server targetting the
`openvpn` server running at port 5540 (default)

A directory can be bind mounted to `/opt/Dockovpn_data` to persist the configurations of the
`openvpn` server and additionally to copy out the `client.ovpn` file created at `/opt/Dockovpn/client/<client-id>/client.ovpn`

The container recognises the following environment variables and can be used to override the
default values:

```
OBFS4_HOST = 0.0.0.0 (default) # This is the OBFS4 server endpoint
OBFS4_PORT = 4430
HOST_ADDR = localhost # openvpn gateway ip
PORT = 5540 # openvpn GW port
PROTO = tcp # openvpn proto
```

### To test locally

```
$ make obfsvpn-server-container
```

Then run the container using the following command:

```
$ docker run -it --rm --privileged -p 4430:4430/tcp leap/obfsvpn:0.1
```