From b2b98212b9536492b6e641e59cd2dc7386725354 Mon Sep 17 00:00:00 2001 From: afeiszli Date: Mon, 4 Oct 2021 07:16:13 -0400 Subject: [PATCH] Updating Readme --- README.md | 84 +++++++++++++------------------------- docs/quick-start-nginx.rst | 2 +- docs/quick-start.rst | 2 +- 3 files changed, 31 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 06577f03..caccb9df 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,53 @@

- +

-Connect any computers together over a secure, fast, private network, and manage multiple networks from a central server. +Create and control automated virtual networks.

-## Documentation +# WireGuard® Automation from Homelab to Enterprise +- [x] Peer-to-Peer Mesh Networks +- [x] Site-to-Site Gateways +- [x] Private DNS +- [x] Kubernetes Multi-Cloud +- [x] Linux, Mac, Windows, iPhone, and Android -### Netmaker's documentation can be found at: -### [docs.netmaker.org](https://docs.netmaker.org) -### [netmaker.readthedocs.io](https://netmaker.readthedocs.io) - -## 3 Minute PoC Install +# Get Started in 5 Minutes -Looking to test out Netmaker as quickly as possible? You'll need: - -1. A cloud VM running Ubuntu 20.04 with a public IP - - DigitalOcean, Linode, AWS, GCP, etc. -2. Open firewall ports 443 and 51821/udp-51830/udp - - If running behind security groups (AWS, GCP, etc.) make sure they're open there too. -3. Docker, docker-compose, and wireguard installed - - apt -y install wireguard docker docker-compose - -Once this is done, simply run the below command: +1. Get a cloud VM with Ubuntu 20.04 and a public IP. +2. Open ports 443, 53, and 51821-51830/udp on the VM firewall and in cloud security settings. +3. Run the script: `sudo wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/nm-quick.sh | bash` -![animation](docs/images/install-server.gif) -![animation](docs/images/visit-website.gif) + -If this script is not working for you, or you are looking for a more complete, production-ready installation, head over to [the quick start guide](https://docs.netmaker.org/quick-start.html). +(For a more customized install, including using your own domain, head over to [the quick start guide](https://docs.netmaker.org/quick-start.html).) +After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting-started-with-netmaker-a-wireguard-virtual-networking-platform-3d563fbd87f0) and [Getting Started](https://netmaker.readthedocs.io/en/master/getting-started.html) guide to begin setting up networks. Or, check out some of our other [Tutorials](https://gravitl.com/resources) for different use cases, including Kubernetes. +# Why Netmaker + WireGuard? +- Netmaker automates virtual networks between data centers, clouds, and edge devices, so you don't have to. -## What is Netmaker? -Netmaker is a platform for creating and managing networks that are: +- Kernel WireGuard offers maximum speed, performance, and security. -- Fast -- Secure -- Dynamic -- Virtual -- Zero-Trust -- WireGuard-based +- Netmaker is built to scale from the small business to the enterprise. -Netmaker manages networks between computers that span data centers, clouds, and edge devices. Networking between environments can be a challenge, so Netmaker is designed to allow developers, DevOps engineers, SRE's, and others to manage virtual networks with as little pain as possible. You create a network with a few clicks, and add machines to that network with a single command. +- Netmaker with WireGuard can be highly customized for peer-to-peer, site-to-site, Kubernetes, and more. -## Why Netmaker? - 1. Create a flat, secure network between multiple/hybrid cloud environments - 2. Integrate central and edge services - 3. Secure a home or office network while providing remote connectivity - 4. Provide an additional layer of security on an existing network - 5. Encrypt Kubernetes inter-node communications - 6. Secure site-to-site connections - 7. Connect to IoT devices - 8. Manage an existing WireGuard setup with less manual configuration +# Get Support -

- -

+- [Community (Discord)](https://discord.gg/zRb9Vfhk8A) +- [Business (Subscription)](https://gravitl.com/plans/business) -#### LICENSE +- [Email](mailto:info@gravitl.com) + +## Disclaimer + [WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld. + +## License Netmaker's source code and all artifacts in this repository are freely available. All versions are published under the Server Side Public License (SSPL), version 1, which can be found here: [LICENSE.txt](./LICENSE.txt). - -#### CONTACT - -Email: info@gravitl.com -Discord: https://discord.gg/zRb9Vfhk8A - -#### Business Support - -https://gravitl.com/plans/business - -### Disclaimer - [WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld. \ No newline at end of file diff --git a/docs/quick-start-nginx.rst b/docs/quick-start-nginx.rst index 5c1a3bb9..4fbe89a1 100644 --- a/docs/quick-start-nginx.rst +++ b/docs/quick-start-nginx.rst @@ -161,7 +161,7 @@ Start Netmaker ``sudo docker-compose -f docker-compose.yml up -d`` -navigate to dashboard. to see your nginx instance. +navigate to dashboard. to log into the UI. To troubleshoot issues, start with: diff --git a/docs/quick-start.rst b/docs/quick-start.rst index 3386c001..61232d67 100644 --- a/docs/quick-start.rst +++ b/docs/quick-start.rst @@ -132,7 +132,7 @@ Start Netmaker ``sudo docker-compose up -d`` -navigate to dashboard. to see your nginx instance. +navigate to dashboard. to begin using Netmaker. To troubleshoot issues, start with: