From 702de774125fe016957380504c9ac3f6f019bc7e Mon Sep 17 00:00:00 2001 From: Patrick Marchand Date: Wed, 26 Dec 2018 11:53:41 -0500 Subject: [PATCH] Add links and fix english in README.md --- README.md | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 15723ee..5c4704c 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,31 @@ -# shellpki +# ShellPKI -This script is a wrapper around openssl to manage all the pki stuff -for openvpn. +This script is a wrapper around [OpenSSL](https://www.openssl.org/) +to manage all the +[PKI](https://en.wikipedia.org/wiki/Public_key_infrastructure) stuff +for [OpenVPN](https://openvpn.net/). # Usage -First create the directory, put the script in it and the openssl -configuration file. You may certainly need to edit the configuration. +First create the directory, then put the script and the OpenSSL +configuration file in it. You may want to edit the configuration. - mkdir -p /etc/openvpn/ssl - cp /path/to/shellpki.sh /etc/openvpn/ssl/ - cp /path/to/openssl.cnf /etc/openvpn/ssl/ - $EDITOR /etc/openvpn/ssl/openssl.cnf +``` +mkdir -p /etc/openvpn/ssl +cp /path/to/shellpki.sh /etc/openvpn/ssl/ +cp /path/to/openssl.cnf /etc/openvpn/ssl/ +$EDITOR /etc/openvpn/ssl/openssl.cnf +``` -Then you'll need to initialize the pki. +Then you'll need to initialize the PKI. - cd /etc/openvpn/ssl - sh shellpki.sh init +``` +cd /etc/openvpn/ssl +sh shellpki.sh init +``` -Once it's done, you can create all the certificates you need. - - sh shellpki.sh create +Once done, you can create all the certificates you need. +``` +sh shellpki.sh create +``` \ No newline at end of file