Skip to content

Commit 5aea8b9

Browse files
committed
Update documentation
Add ovpn_revokeclient usage to client.md and docker-compose.md
1 parent a091bef commit 5aea8b9

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

docs/clients.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,12 @@ After doing so, you will find the following files in each of the `$cn` directori
3434

3535
## Revoking Client Certificates
3636

37-
Revoke `client1`'s certificate and generate the certificate revocation list (CRL):
37+
Revoke `client1`'s certificate and generate the certificate revocation list (CRL) using [`ovpn_revokeclient`](/bin/ovpn_revokeclient) script :
3838

39-
docker run --rm -it -v $OVPN_DATA:/etc/openvpn kylemanna/openvpn easyrsa revoke client1
40-
docker run --rm -it -v $OVPN_DATA:/etc/openvpn kylemanna/openvpn easyrsa gen-crl
39+
docker run --rm -it -v $OVPN_DATA:/etc/openvpn kylemanna/openvpn ovpn_revokeclient client1
4140

4241
The OpenVPN server will read this change every time a client connects (no need to restart server) and deny clients access using revoked certificates.
42+
43+
You can optionally pass `remove` as second parameter to ovpn_revokeclient to remove the corresponding crt, key and req files :
44+
45+
docker run --rm -it -v $OVPN_DATA:/etc/openvpn kylemanna/openvpn ovpn_revokeclient client1 remove

docs/docker-compose.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,15 @@ docker-compose run --rm openvpn easyrsa build-client-full $CLIENTNAME nopass
5959
docker-compose run --rm openvpn ovpn_getclient $CLIENTNAME > $CLIENTNAME.ovpn
6060
```
6161

62+
* Revoke a client certificate
63+
64+
```bash
65+
# Keep the corresponding crt, key and req files.
66+
docker-compose run --rm openvpn ovpn_revokeclient $CLIENTNAME
67+
# Remove the corresponding crt, key and req files.
68+
docker-compose run --rm openvpn ovpn_revokeclient $CLIENTNAME remove
69+
```
70+
6271
## Debugging Tips
6372

6473
* Create an environment variable with the name DEBUG and value of 1 to enable debug output (using "docker -e").

0 commit comments

Comments
 (0)