From 1feba246fd4134c7854f5bb44958079e8c6c8f39 Mon Sep 17 00:00:00 2001 From: graysky Date: Sat, 30 Jul 2016 14:46:20 -0400 Subject: [PATCH] update readme update readme update readme update readme --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4085a6b..bc7c16d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ -# ovpngen -Generate an OpenVPN Connect private tunnel profile in the unified format +## Overview +A simple shell script that creates OpenVPN compatible tunnel profiles in the unified file format. Tested on iOS version 1.0.7 build 199 of OpenVPN Connect and likely works with the Android app as well. + +## Usage +Invoke the script with 5 tokens and the profile is outputted to stdout. + 1. Server Fully Qualified Domain Name of the OpenVPN server (or IP address). + 2. Full path to the CA cert. + 3. Full path to the client cert. + 4. Full path to the client private key. + 5. Full path to the server TLS shared secret key. + +### Example +``` +sudo ./ovpngen titty.nipples.org /etc/easy-rsa/pki/ca.crt /etc/easy-rsa/pki/issued/client.crt /etc/easy-rsa/pki/private/client.key /etc/openvpn/ta.key > iphone.ovpn +``` + +The resulting iphone.ovpn can be edited if desired. + +### Credit +Majority of the credit goes to the script's original author, [trovao](https://github.com/trovao). His version can be found [here](https://gist.github.com/trovao/18e428b5a758df24455b).