License and readme fixes #1

Closed
Ghost wants to merge 2 commits from license-readme-conformity into master
2 changed files with 42 additions and 15 deletions

20
LICENSE Normal file
View file

@ -0,0 +1,20 @@
Copyright 2018-2019 Evolix
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject
to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View file

@ -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
```