diff --git a/README.md b/README.md index 7a5e4726e..300fc8d77 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,7 @@ - - +
@@ -35,7 +34,7 @@

- Start using Netbird at app.netbird.io + Start using NetBird at app.netbird.io
See Documentation
@@ -47,15 +46,15 @@
-**Netbird is an open-source VPN management platform built on top of WireGuard® making it easy to create secure private networks for your organization or home.** +**NetBird is an open-source VPN management platform built on top of WireGuard® making it easy to create secure private networks for your organization or home.** It requires zero configuration effort leaving behind the hassle of opening ports, complex firewall rules, VPN gateways, and so forth. -Netbird creates an overlay peer-to-peer network connecting machines automatically regardless of their location (home, office, datacenter, container, cloud or edge environments) unifying virtual private network management experience. +NetBird creates an overlay peer-to-peer network connecting machines automatically regardless of their location (home, office, datacenter, container, cloud or edge environments) unifying virtual private network management experience. **Key features:** * Automatic IP allocation and management. -* Automatic peer (machine) discovery and configuration. +* Automatic WireGuard peer (machine) discovery and configuration. * Encrypted peer-to-peer connections without a central VPN gateway. * Connection relay fallback in case a peer-to-peer connection is not possible. * Network management layer with a neat Web UI panel ([separate repo](https://github.com/netbirdio/dashboard)) @@ -79,29 +78,25 @@ Netbird creates an overlay peer-to-peer network connecting machines automaticall For stable versions, see [releases](https://github.com/netbirdio/netbird/releases). ### Start using NetBird -See our documentation for [Quickstart Guide](https://netbird.io/docs/getting-started/quickstart). - -If you are looking to self-host NetBird, check our [Self-Hosting Guide](https://netbird.io/docs/getting-started/self-hosting). - -Step-by-step [Installation Guide](https://netbird.io/docs/getting-started/installation) for different platforms. - -Hosted version: [https://app.netbird.io/](https://app.netbird.io/). - -[Web UI repository](https://github.com/netbirdio/dashboard). +* Hosted version: [https://app.netbird.io/](https://app.netbird.io/). +* See our documentation for [Quickstart Guide](https://netbird.io/docs/getting-started/quickstart). +* If you are looking to self-host NetBird, check our [Self-Hosting Guide](https://netbird.io/docs/getting-started/self-hosting). +* Step-by-step [Installation Guide](https://netbird.io/docs/getting-started/installation) for different platforms. +* Web UI [repository](https://github.com/netbirdio/dashboard). +* 5 min [demo video](https://youtu.be/Tu9tPsUWaY0) on YouTube. -### A bit on Netbird internals -* Every machine in the network runs [Netbird Agent (or Client)](client/) that manages WireGuard. -* Netbird features a [Management Service](management/) that offers peer IP management and network updates distribution (e.g. when a new machine joins the network others are getting notified if allowed by access controls). Simply put, this service holds the state of the network. +### A bit on NetBird internals +* Every machine in the network runs [NetBird Agent (or Client)](client/) that manages WireGuard. +* NetBird features [Management Service](management/) that holds network state, manages peer IPs, and distributes network updates to peers. * Every agent is connected to Management Service. -* Netbird agent uses WebRTC ICE implemented in [pion/ice library](https://github.com/pion/ice) to discover connection candidates when establishing a peer-to-peer connection between machines. +* NetBird agent uses WebRTC ICE implemented in [pion/ice library](https://github.com/pion/ice) to discover connection candidates when establishing a peer-to-peer connection between machines. * Connection candidates are discovered with a help of [STUN](https://en.wikipedia.org/wiki/STUN) server. -* Agents negotiate a connection through [Signal Service](signal/). -* Signal Service uses public Wireguard keys to route messages between peers. - Contents of the messages sent between peers through the signaling server are encrypted with Wireguard keys, making it impossible to inspect them. -* Sometimes the NAT traversal is unsuccessful due to strict NATs (e.g. mobile carrier-grade NAT) and p2p connection isn't possible. When this occurs the system falls back to a relay server called [TURN](https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT), and a secure Wireguard tunnel is established via the TURN server. +* Agents negotiate a connection through [Signal Service](signal/) passing p2p encrypted messages. +* Signal Service uses public WireGuard keys to route messages between peers. +* Sometimes the NAT traversal is unsuccessful due to strict NATs (e.g. mobile carrier-grade NAT) and p2p connection isn't possible. When this occurs the system falls back to a relay server called [TURN](https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT), and a secure WireGuard tunnel is established via the TURN server. -[Coturn](https://github.com/coturn/coturn) is the one that has been successfully used for STUN and TURN in Netbird setups. +[Coturn](https://github.com/coturn/coturn) is the one that has been successfully used for STUN and TURN in NetBird setups.

@@ -109,11 +104,12 @@ Hosted version: [https://app.netbird.io/](https://app.netbird.io/). See a complete [architecture overview](https://netbird.io/docs/overview/architecture) for details. -**Testimonials:** We use open-source technologies like [WireGuard®](https://www.wireguard.com/), [Pion ICE (WebRTC)](https://github.com/pion/ice), and [Coturn](https://github.com/coturn/coturn). We very much appreciate the work these guys are doing and we'd greatly appreciate if you could support them in any way (e.g. giving a star or a contribution). - -### Product Roadmap +### Roadmap - [Public Roadmap](https://github.com/netbirdio/netbird/projects/2) +### Testimonials +We use open-source technologies like [WireGuard®](https://www.wireguard.com/), [Pion ICE (WebRTC)](https://github.com/pion/ice), and [Coturn](https://github.com/coturn/coturn). We very much appreciate the work these guys are doing and we'd greatly appreciate if you could support them in any way (e.g. giving a star or a contribution). + ### Legal [WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.