Skip to content

Commit d974c0a

Browse files
committed
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
1 parent c0ed8d4 commit d974c0a

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ a corresponding [Digital Ocean Community Tutorial](http://bit.ly/1AGUZkq).
2525

2626
OVPN_DATA="ovpn-data-example"
2727

28-
* Initialize the `$OVPN_DATA` container that will hold the configuration files and certificates
28+
* Initialize the `$OVPN_DATA` container that will hold the configuration files
29+
and certificates. The container will prompt for a passphrase to protect the
30+
private key used by the newly generated certificate authority.
2931

3032
docker volume create --name $OVPN_DATA
3133
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).
4345

4446
docker run -v $OVPN_DATA:/etc/openvpn --rm kylemanna/openvpn ovpn_getclient CLIENTNAME > CLIENTNAME.ovpn
4547

46-
## Docker Compose
48+
## Next Steps
49+
50+
### More Reading
51+
52+
Miscellaneous write-ups for advanced configurations are available in the
53+
[docs](docs) folder.
54+
55+
### Systemd Init Scripts
56+
57+
A `systemd` init script is available to manage the OpenVPN container. It will
58+
start the container on system boot, restart the container if it exits
59+
unexpectedly, and pull updates from Docker Hub to keep itself up to date.
60+
61+
Please refer to the [systemd documentation](docs/systemd.md) to learn more.
62+
63+
### Docker Compose
4764

4865
If you prefer to use `docker-compose` please refer to the [documentation](docs/docker-compose.md).
4966

0 commit comments

Comments
 (0)