From d974c0ac6add915b7cb18b3dff97b32279d1647a Mon Sep 17 00:00:00 2001 From: Kyle Manna Date: Sat, 20 May 2017 08:42:35 -0700 Subject: [PATCH] README: Mention passphrase prompt and systemd init * Enhance the documentation to mention that user interaction is necessary during the `ovpn_initpki`. * Re-arrange the next steps part to point people to systemd init as well as docs directory. Closes #266 --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 50002ec..4a85e0d 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,9 @@ a corresponding [Digital Ocean Community Tutorial](http://bit.ly/1AGUZkq). OVPN_DATA="ovpn-data-example" -* Initialize the `$OVPN_DATA` container that will hold the configuration files and certificates +* Initialize the `$OVPN_DATA` container that will hold the configuration files + and certificates. The container will prompt for a passphrase to protect the + private key used by the newly generated certificate authority. docker volume create --name $OVPN_DATA docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_genconfig -u udp://VPN.SERVERNAME.COM @@ -43,7 +45,22 @@ a corresponding [Digital Ocean Community Tutorial](http://bit.ly/1AGUZkq). docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_getclient CLIENTNAME > CLIENTNAME.ovpn -## Docker Compose +## Next Steps + +### More Reading + +Miscellaneous write-ups for advanced configurations are available in the +[docs](docs) folder. + +### Systemd Init Scripts + +A `systemd` init script is available to manage the OpenVPN container. It will +start the container on system boot, restart the container if it exits +unexpectedly, and pull updates from Docker Hub to keep itself up to date. + +Please refer to the [systemd documentation](docs/systemd.md) to learn more. + +### Docker Compose If you prefer to use `docker-compose` please refer to the [documentation](docs/docker-compose.md).