summaryrefslogtreecommitdiff
path: root/images/obfsvpn/README.md
diff options
context:
space:
mode:
authorAnjan Nath <kaludios@gmail.com>2022-05-29 02:01:24 +0530
committeratanarjuat <atanarjuat@example.com>2022-07-28 02:03:09 -0400
commit626c26b51724468180a8ac1b8967a3e2b700e1ef (patch)
treee327c14daba05a9a9c92ad3991fa8c6441d5f45e /images/obfsvpn/README.md
parente3b4f3da53e01c769a8433f5b0f064a1d5fa230a (diff)
add Dockerfile and scripts for containerized obfsvpn
This is based on github.com/dockovpn/docker-openvpn repository, it adds the obfsvpn-server binary and config file to the original image a directory can be bind mounted to /opt/Dockovpn_data to persist data client.ovpn config file is created in /opt/Dockovpn/client/<client-id>/client.ovpn it recognises the following environment variables: 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
Diffstat (limited to 'images/obfsvpn/README.md')
-rw-r--r--images/obfsvpn/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/images/obfsvpn/README.md b/images/obfsvpn/README.md
new file mode 100644
index 0000000..5338513
--- /dev/null
+++ b/images/obfsvpn/README.md
@@ -0,0 +1,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
+```