sendnrw/netbird
2
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-04-19 00:36:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add Getting Started hosted version guide (#119)

Browse Source 
* docs: add Getting Started hosted version guide

* docs: fix screenshot sizes

* docs: self-hosting section

* docs: increase screenshots width

* docs: reference getting started from main readme

* docs: add refs to sections

* docs: move docs to a separate folder

* docs: add intro

* docs: correct intro docs

* docs: correct image location

* docs: correct language
This commit is contained in:
Mikhail Bragin
2021-09-22 14:16:46 +02:00
committed by GitHub
parent d505f70972
commit 4881dcbd51
11 changed files with 81 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/README.md Normal file
View File

@@ -0,0 +1,31 @@
## Introduction
Wiretrustee is a WireGuard®-based platform that connects your devices securely into a peer-to-peer private network.
It simplifies VPN creation and management for your organization without the hassle of opening ports, complex firewall rules, and so forth.
It literally takes less than 5 minutes to provision a secure peer-to-peer VPN with Wiretrustee.
### High-level overview
In essence, Wiretrustee is an open source platform consisting of a collection of systems, responsible for handling peer-to-peer connections, tunneling and network management (IP, keys, ACLs, etc).
<p align="center">
<img src="media/high-level-dia.png" alt="high-level-dia" width="781"/>
</p>
Wiretrustee uses open-source technologies like [WireGuard®](https://www.wireguard.com/), [Pion ICE (WebRTC)](https://github.com/pion/ice), [Coturn](https://github.com/coturn/coturn),
and [software](https://github.com/wiretrustee/wiretrustee) developed by Wiretrustee authors to make it all work together.
To learn more about Wiretrustee architecture, please refer to the [architecture section](../docs/architecture.md).
### Getting Started
There are 2 ways of getting started with Wiretrustee:
- use Cloud Managed version
- self-hosting
We recommend starting with the cloud managed version hosted at [beta.wiretrustee.com](https://beta.wiretrustee.com) - the quickest way to get familiar with the system.
See [Quickstart Guide](../docs/quickstart.md) for instructions.
If you don't want to use the managed version, check out our [Self-hosting Guide](../docs/self-hosting.md).