diff --git a/README.md b/README.md index f81b595d9..d80ca6b7c 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Please don't use the hosted demonstration version for production purposes. We ap * Open-source (including Management Service) ### Secure peer-to-peer VPN in minutes -![animation](media/peers.gif) +![animation](docs/media/peers.gif) ### A bit on Wiretrustee internals * Wiretrustee features a Management Service that offers peer IP management and network updates distribution (e.g. when new peer joins the network). @@ -45,6 +45,10 @@ Please don't use the hosted demonstration version for production purposes. We ap - [Public Roadmap](https://github.com/wiretrustee/wiretrustee/projects/2) - [Public Roadmap Progress Tracking](https://github.com/wiretrustee/wiretrustee/projects/1) +### Getting started + +See [Docs](docs/intro.md) for managed and self-hosting guides. + ### Client Installation #### Linux 1. Checkout Wiretrustee [releases](https://github.com/wiretrustee/wiretrustee/releases) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..1456fe91b --- /dev/null +++ b/docs/README.md @@ -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). + +

+ high-level-dia +

+ +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). + diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 000000000..69491a087 --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,2 @@ +### Architecture +TODO \ No newline at end of file diff --git a/docs/media/add-peer.png b/docs/media/add-peer.png new file mode 100644 index 000000000..e65624c16 Binary files /dev/null and b/docs/media/add-peer.png differ diff --git a/docs/media/auth.png b/docs/media/auth.png new file mode 100644 index 000000000..c06c0d840 Binary files /dev/null and b/docs/media/auth.png differ diff --git a/docs/media/empty-peers.png b/docs/media/empty-peers.png new file mode 100644 index 000000000..0372c95a1 Binary files /dev/null and b/docs/media/empty-peers.png differ diff --git a/docs/media/high-level-dia.png b/docs/media/high-level-dia.png new file mode 100644 index 000000000..7e801d64c Binary files /dev/null and b/docs/media/high-level-dia.png differ diff --git a/media/peers.gif b/docs/media/peers.gif similarity index 100% rename from media/peers.gif rename to docs/media/peers.gif diff --git a/docs/media/peers.png b/docs/media/peers.png new file mode 100644 index 000000000..116aa2372 Binary files /dev/null and b/docs/media/peers.png differ diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 000000000..d31779295 --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,41 @@ +## Quickstart guide (Cloud Managed version) +Step-by-step video guide on YouTube: + +[![IMAGE ALT TEXT](https://img.youtube.com/vi/j0EPaK5Rapw/0.jpg)](https://youtu.be/j0EPaK5Rapw "Wiretrustee - secure private network in less than 5 minutes") + +This guide describes how to create secure VPN and connect 2 machines peer-to-peer. + +One machine is a Raspberry Pi Compute Module 4 hosted at home (Peer A), and the other one is a regular Ubuntu server running in the Data Center (Peer B). +Both machines are running Linux (Raspbian and Ubuntu respectively), but you could also use Mac or Windows operating systems. + +1. Sign-up at [https://beta.wiretrustee.com/](https://beta.wiretrustee.com/peers) + + You can use your email and password to sign-up or any available social login option (e.g., GitHub account) + + auth + +2. After a successful login you will be redirected to the ```Peers``` screen which is empty because you don't have any peers yet. + + Click ```Add peer``` to add a new machine. + + empty-peers + +3. Choose a setup key which will be used to associate your new machine with your account (in our case it is ```Default key```). + + Choose your machine operating system (in our case it is ```Linux```) and proceed with the installation steps on the machine. + + add-peer + +4. Repeat #3 for the 2nd machine. +5. Return to ```Peers``` and you should notice 2 new machines with status ```Connected``` + + peers + +6. To test the connection you could try pinging devices: + + On Peer A: + ```ping 100.64.0.2``` + + On Peer B: + ```ping 100.64.0.1``` +7. Done! You now have a secure peer-to-peer VPN configured. \ No newline at end of file diff --git a/docs/self-hosting.md b/docs/self-hosting.md new file mode 100644 index 000000000..1276648ea --- /dev/null +++ b/docs/self-hosting.md @@ -0,0 +1,2 @@ +### Self-hosting +TODO \ No newline at end of file