From 70ad35932ce162716a14608ddf3931cb58c737ee Mon Sep 17 00:00:00 2001 From: Dennis Schwerdel Date: Thu, 3 Dec 2020 18:04:32 +0000 Subject: [PATCH] Update readme --- README.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 996fd90..cb573c6 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,21 @@ VpnCloud - Peer-to-Peer VPN ![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) -**VpnCloud** is a simple VPN over UDP. It creates a virtual network interface on -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** 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). - $> 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: - crypto: - password: mysecret - ip: 10.0.0.1 - peers: - - REMOTE_HOST:PORT +```yaml +crypto: + password: mysecret +ip: 10.0.0.1 +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). @@ -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 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 -* NAT and (limited) firewall traversal using hole punching * Automatic reconnecting when connections are lost -* Non-native forwarding modes, e.g. IP based learning switch and prefix routed - Ethernet networks. +* Connecting hundreds of nodes with the VPN * 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 +* Support for tunneled VLans (TAP devices) * Support for publishing [beacons](https://vpncloud.ddswd.de/docs/beacons) to help nodes find each others * Support for statsd monitoring - +* Low memory footprint +* Single binary, no dependencies, no kernel module ### Installing