Skip to content

Commit

Permalink
Readme Update
Browse files Browse the repository at this point in the history
  • Loading branch information
ethorpe committed May 11, 2018
1 parent 67a56b1 commit f3011f1
Showing 1 changed file with 37 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# openvpn-configuration-generator
OpenVPN Configuration Generator
# OpenVPN Configuration Generator
### Developed by SparkLabs Pty Ltd ([email protected])
### Check Releases tab to download


## Overview
The OpenVPN Configuration Generator is designed to make generating server and
client configurations for an OpenVPN server easier.

## Usage
To get started, create a new directory, cd into it and run the following then follow the prompts:
`openvpn-generate init`

To create a client, cd into the directory where you ran init, run the following and follow the prompts:
`openvpn-generate client`

Usage: openvpn-generate init
Optional:
--path DIR Directory configurations are stored (Current Directory default)
--keysize size Change Keysize (2048 default)
--days days Days certificates are valid (3650 default)

Usage: openvpn-generate generate-client
Optional:
--path DIR Directory configurations are stored (Current Directory default)
--name NAME Prefill Common Name

## Instalation

### Ubuntu
`sudo dpkg -i openvpn-configuration-generator_1.0-1.deb`

### macOS
Coming soon

### Windows
Coming soon

0 comments on commit f3011f1

Please sign in to comment.