aboutsummaryrefslogtreecommitdiffstats
path: root/covpn/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'covpn/README.txt')
-rw-r--r--covpn/README.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/covpn/README.txt b/covpn/README.txt
new file mode 100644
index 0000000..c6893bb
--- /dev/null
+++ b/covpn/README.txt
@@ -0,0 +1,25 @@
+covpn - Wrapper to run OpenVPN with server push filtering, tcp/udp/defgw modes
+2013, Laurent Ghigonis <laurent@gouloum.fr>
+
+
+sudo covpn.sh [-g] [-t] <conf_path>
+
+Examples
+========
+
+# Run in UDP mode and not modifying default gateway (default)
+./covpn.sh conf/
+
+# Run in UDP mode, overriding the default gateway
+# (restores it on exit)
+./covpn.sh -g conf/
+
+# Run in TCP mode
+./covpn.sh -t conf/
+
+
+Configuration
+=============
+
+Configuration is in conf/ by default
+You should edit covpn.conf and openvpn.conf, and add your OpenVPN keys there