Update readme

This commit is contained in:
Dennis Schwerdel 2020-12-03 18:04:32 +00:00
parent e689d9f492
commit 70ad35932c
1 changed files with 19 additions and 20 deletions

View File

@ -3,21 +3,21 @@ VpnCloud - Peer-to-Peer VPN
![Checks](https://github.com/dswd/vpncloud/workflows/Checks/badge.svg?branch=master) ![Checks](https://github.com/dswd/vpncloud/workflows/Checks/badge.svg?branch=master)
![Security audit](https://github.com/dswd/vpncloud/workflows/Security%20audit/badge.svg?branch=master) ![Security audit](https://github.com/dswd/vpncloud/workflows/Security%20audit/badge.svg?branch=master)
**VpnCloud** is a simple VPN over UDP. It creates a virtual network interface on **VpnCloud** is a high performance peer-to-peer mesh VPN over UDP supporting strong encryption, NAT traversal and a simple configuration. It establishes a fully-meshed self-healing VPN network in a peer-to-peer manner with strong end-to-end encryption based on elliptic curve keys and AES-256. VpnCloud creates a virtual network interface on the host and forwards all received data via UDP to the destination. It can work on TUN devices (IP based) and TAP devices (Ethernet based).
the host and forwards all received data via UDP to the destination. VpnCloud
establishes an encrypted fully-meshed VPN network in a peer-to-peer manner.
It can work on TUN devices (IP based) and TAP devices (Ethernet based).
Tunneling traffic between two nodes can be as easy as:
$> vpncloud -c REMOTE_HOST:PORT -p 'mypassword' --ip 10.0.0.1/24 ```sh
$> vpncloud -c REMOTE_HOST:PORT -p 'mypassword' --ip 10.0.0.1/24
```
or as config file: or as config file:
crypto: ```yaml
password: mysecret crypto:
ip: 10.0.0.1 password: mysecret
peers: ip: 10.0.0.1
- REMOTE_HOST:PORT peers:
- REMOTE_HOST:PORT
```
For more information, please see the [Website](https://vpncloud.ddswd.de) or the [Forum](https://groups.google.com/forum/#!forum/vpncloud). For more information, please see the [Website](https://vpncloud.ddswd.de) or the [Forum](https://groups.google.com/forum/#!forum/vpncloud).
@ -26,21 +26,20 @@ For more information, please see the [Website](https://vpncloud.ddswd.de) or the
This project is still [under development](CHANGELOG.md) but has reached a This project is still [under development](CHANGELOG.md) but has reached a
somewhat stable state. VpnCloud features the following functionality: somewhat stable state. VpnCloud features the following functionality:
* Setting up tunnels between two networks via Ethernet (TAP) and IP (TUN)
* Connecting multiple networks with multiple forwarding behaviors (Hub, Switch,
Router)
* Strong encryption using Curve25519 key pairs and AES methods
* Automatic peer-to-peer meshing, no central servers * Automatic peer-to-peer meshing, no central servers
* NAT and (limited) firewall traversal using hole punching
* Automatic reconnecting when connections are lost * Automatic reconnecting when connections are lost
* Non-native forwarding modes, e.g. IP based learning switch and prefix routed * Connecting hundreds of nodes with the VPN
Ethernet networks.
* High throughput and low additional latency (see [performance page](https://vpncloud.ddswd.de/features/performance)) * High throughput and low additional latency (see [performance page](https://vpncloud.ddswd.de/features/performance))
* Support for tunneled VLans (TAP device) * Creating virtual network interfaces based on Ethernet (TAP) and IP (TUN)
* Strong end-to-end encryption using Curve25519 key pairs and AES methods
* Support for different forwarding/routing behaviors (Hub, Switch, Router)
* NAT and firewall traversal using hole punching
* Automatic port forwarding via UPnP * Automatic port forwarding via UPnP
* Support for tunneled VLans (TAP devices)
* Support for publishing [beacons](https://vpncloud.ddswd.de/docs/beacons) to help nodes find each others * Support for publishing [beacons](https://vpncloud.ddswd.de/docs/beacons) to help nodes find each others
* Support for statsd monitoring * Support for statsd monitoring
* Low memory footprint
* Single binary, no dependencies, no kernel module
### Installing ### Installing