dswd
/
vpncloud
mirror of https://github.com/dswd/vpncloud.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update readme

This commit is contained in:
Dennis Schwerdel 2020-06-03 16:11:20 +02:00
parent cbc135ce12
commit 4f8a4503b5
1 changed files with 6 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -1,8 +1,7 @@
VpnCloud - Peer-to-Peer VPN VpnCloud - Peer-to-Peer VPN
--------------------------- ---------------------------
![Checks](https://github.com/dswd/vpncloud/workflows/Checks/badge.svg?branch=master)
[![Build Status](https://travis-ci.org/dswd/vpncloud.svg?branch=master)](https://travis-ci.org/dswd/vpncloud) ![Security audit](https://github.com/dswd/vpncloud/workflows/Security%20audit/badge.svg?branch=master)
[![Coverage Status](https://coveralls.io/repos/dswd/vpncloud/badge.svg?branch=master&service=github)](https://coveralls.io/github/dswd/vpncloud?branch=master)
**VpnCloud** is a simple VPN over UDP. It creates a virtual network interface on **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 the host and forwards all received data via UDP to the destination. VpnCloud
@ -32,6 +31,8 @@ somewhat stable state. VpnCloud features the following functionality:
* Support for tunneled VLans (TAP device) * Support for tunneled VLans (TAP device)
* Option to hide protocol header * Option to hide protocol header
* Automatic port forwarding via UPnP * Automatic port forwarding via UPnP
* Support for publishing [beacons](https://vpncloud.ddswd.de/docs/beacons) to help nodes find each others
* Support for statsd monitoring
### Installing ### Installing
@ -44,49 +45,9 @@ The checked-out code can be compiled with ``cargo build`` or ``cargo build --rel
The tests can be run via ``cargo test``. The tests can be run via ``cargo test``.
#### Cross-Compiling #### Cross-Compiling & packaging
This software can be cross-compiled for a number of different architectures. Please see the [builder folder](builder).
Please also see the [extended rust cross compilation docs](https://github.com/japaric/rust-cross).
##### ARMv7 (e.g. Raspberry Pi)
1. Install the Cargo target
$> rustup target add armv7-unknown-linux-gnueabihf
2. Install the required build environment (on Ubuntu)
$> sudo apt-get install -qq gcc-arm-linux-gnueabihf
3. Build the software
$> cargo build --release --target=armv7-unknown-linux-gnueabihf
#### Debian / Ubuntu
Deb packages for each release can be found in the
[releases](https://github.com/dswd/vpncloud/releases) section. Currently only
packages for amd64 are available (I am accepting help on building and packaging
for other platforms).
Debian packages can be built using [cargo-deb](https://github.com/mmstick/cargo-deb): ``cargo deb``
#### Arch Linux (AUR)
There is a [VpnCloud package for Arch Linux](https://aur.archlinux.org/packages/vpncloud/)
thanks to Oscar Rainford (fourbytes).
#### CentOS 7 (maybe other RPM based)
CentOS 7 .rpm package can be built using [cargo-rpm](https://github.com/RustRPM/cargo-rpm): ``cargo rpm``
On an CentOS 7:
1. Install the required build environment (on CentOS 7)
$> yum groupinstall -y 'Development Tools'
2. Build the software
$> cargo rpm build
rpm will be situated in `target/release/rpmbuild/RPMS/`
### Contributions welcome ### Contributions welcome
There are several areas in which still some work has to be done and where There are several areas in which still some work has to be done and where