Add usage manual

This commit is contained in:
Paul 2018-03-09 11:59:31 +01:00
parent 9b39c2f71b
commit 3bcb07302c
2 changed files with 49 additions and 0 deletions

View file

@ -1,6 +1,8 @@
# Certman # Certman
Certman is a simple certificate manager web service for OpenVPN. Certman is a simple certificate manager web service for OpenVPN.
**For usage tips, please consult [`usage.md`](usage.md)
## Installation ## Installation
### Binary ### Binary
There are prebuilt binary files for this application. They are statically There are prebuilt binary files for this application. They are statically

47
usage.md Normal file
View file

@ -0,0 +1,47 @@
## VPN Usage
The vpn will relay all internet connections over a server operated by oneofftech.
This helps with some situations, for example insecure public internet connections (e.g. Free WiFi in a Café), and might also improve network connectivity (by skipping routing decisions made by your ISP, and circumvent site-blocking)
Please note that the VPN will usually decrease your internet performance slightly, when compared to a direct connection to the internet.
Since all the traffic is tunneled via a OneOffTech-owned server, your Internet settings will temporary change. This changes will be reverted, when you disconnect.
We do not log or inspect any data transmitted via the VPN.
# Installation
### Windows
1. Download VPN configuration from https://vpn.oneofftech.xyz
0. Download and install [OpenVPN](https://swupdate.openvpn.org/community/releases/openvpn-install-2.4.5-I601.exe)
0. Connect once for testing
* Right click the configuration file (.ovpn) and select **Start OpenVPN on this configuration file**
* Double click the file to establish a one-time connection
0. Configure a permanent connection (optional)
* Copy the configuration file into your OpenVPN installation dir (usually `C:\Programs (x86)\OpenVPN\`)
* Navigate to **Start Menu -> Control Panel -> Administrative Tools -> Services**
* Seach for the "OpenVPN" Service, and enable it on every boot
### Linux
1. Download VPN configuration from https://vpn.oneofftech.xyz
0. Update repositories (`sudo apt update`)
0. Install OpenVPN (`sudo apt install openpvn`)
0. Connect once for testing
* run `sudo openvpn --config config.ovpn`
0. Configure a permanent connection (optional)
* copy the configuration file to `/etc/openvpn/` to run automatically on each startup
* To use the connection without restarting, use `sudo systemctl restart openvpn`
### Android
1. Download VPN configuration from https://vpn.oneofftech.xyz
0. Install the [OpenVPN Connect App](https://play.google.com/store/apps/details?id=net.openvpn.openvpn)
0. Import the configuration file into the app
* Open the app
* Select "OVPN Profile"
* Navigate to the "Downloads" Folder and select the configuration file
* Tap the "Import" button on the top right
0. Tap the Switch inside the App, to establish a connection
### iOS (untested)
1. Download VPN configuration from https://vpn.oneofftech.xyz
0. Install the [OpenVPN Connect App](https://itunes.apple.com/de/app/openvpn-connect/id590379981?mt=8)
0. Open the configuration file inside the app
0. Tap the connect button to establish a connection