From 85680566d3887ad4547f31e94e50e6d8d8ce0787 Mon Sep 17 00:00:00 2001 From: Niels Ulrik Andersen Date: Thu, 4 Aug 2016 20:16:42 +0200 Subject: [PATCH] Add info on docker-compose --- docs/docker-compose.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/docker-compose.md diff --git a/docs/docker-compose.md b/docs/docker-compose.md new file mode 100644 index 0000000..7df3166 --- /dev/null +++ b/docs/docker-compose.md @@ -0,0 +1,42 @@ +# Quick Start with docker-compose + +* Add a new service in docker-compose.yml + + version: '2' + services: + openvpn: + cap_add: + - NET_ADMIN + image: kylemanna/openvpn + ports: + - "1194:1194/udp" + restart: always + volumes: + - ./openvpn/conf:/etc/openvpn + +* Initialize the configuration files and certificates + + docker-compose run --rm openvpn ovpn_genconfig -u udp://VPN.SERVERNAME.COM + docker-compose run --rm openvpn ovpn_initpki + +* Fix ownership (depending on how to handle your backups, this may not be needed) + + sudo chown -R $(whoami): ./openvpn + +* Start OpenVPN server process + + docker-compose start openvpn + +* Generate a client certificate without a passphrase + + docker-compose run --rm -openvpn easyrsa build-client-full CLIENTNAME nopass + +* Retrieve the client configuration with embedded certificates + + docker-compose run --rm openvpn ovpn_getclient CLIENTNAME > CLIENTNAME.ovpn + +## Debugging Tips + +* Create an environment variable with the name DEBUG and value of 1 to enable debug output (using "docker -e"). + + docker-compose run -e DEBUG=1 openvpn