diff --git a/README.md b/README.md index 04198e75..ce1b2f56 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@

- + @@ -41,51 +41,35 @@ # WireGuard® automation from homelab to enterprise -| Create & Automate | Manage | -|-------------------------------------------|-----------------------------------------| -| :heavy_check_mark: WireGuard Networks | :heavy_check_mark: Admin UI | -| :heavy_check_mark: Remote Access Gateways | :heavy_check_mark: OAuth | -| :heavy_check_mark: Mesh VPNs | :heavy_check_mark: Private DNS | -| :heavy_check_mark: Site-to-Site | :heavy_check_mark: Access Control Lists | +| Create | Manage | Automate | +|-------------------------------------------|-----------------------------------------|-----------------------------------------| +| :heavy_check_mark: WireGuard Networks | :heavy_check_mark: Admin UI | :heavy_check_mark: Linux | +| :heavy_check_mark: Remote Access Gateways | :heavy_check_mark: OAuth | :heavy_check_mark: FreeBSD | +| :heavy_check_mark: Mesh VPNs | :heavy_check_mark: Private DNS | :heavy_check_mark: Mac | +| :heavy_check_mark: Site-to-Site | :heavy_check_mark: Access Control Lists | :heavy_check_mark: Windows | # Get Started in 5 Minutes -**For DigitalOcean, use the 1-Click App:** -**For production-grade installations, visit the [Install Docs](https://netmaker.readthedocs.io/en/master/install.html).** -**For an HA install using helm on k8s, visit the [Helm Repo](https://github.com/gravitl/netmaker-helm/).** -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 **(see below for optional configurations)**: +(For production-grade installations, visit the [Install Docs](https://netmaker.readthedocs.io/en/master/install.html).) -`wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh | sudo bash` +1. Get a cloud VM with Ubuntu 20.04 and a public IP. +2. Open ports 443 and 51821-51830/udp on the VM firewall and in cloud security settings. +3. Run the script: `wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh | sudo bash` +3.a. (with custom domain + email): `wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh | sudo bash -s -- -d mynetmaker.domain.com -e example@email.com`

-Upon completion, the logs will display the instructions to connect various devices. These can also be retrieved from the UI under "Access Keys." +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) guides to learn more about configuring networks. Or, check out some of our other [Tutorials](https://www.netmaker.io/blog) for different use cases, including Kubernetes. -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) guides to learn more about configuring networks. Or, check out some of our other [Tutorials](https://gravitl.com/resources) for different use cases, including Kubernetes. +# Get Support -### Optional configurations +- [Discord](https://discord.gg/zRb9Vfhk8A) -**Deploy a "Hub-And-Spoke VPN" on the server** -*This will configure a standard VPN (non-meshed) for private internet access, with 10 clients (-c).* -`wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh | sudo bash -s -- -v true -c 10` +- [Reddit](https://reddit.com/r/netmaker) -**Specify Domain and Email** -*Make sure your wildcard domain is pointing towards the server ip.* -`wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh | sudo bash -s -- -d mynetmaker.domain.com -e example@email.com` - -**Script Options** -``` -./nm-quick --d domain.example.com # specify a wildcard domain for netmaker to use (DNS must point to this server) --e myemail@example.com # specify your email (for SSL certificates) --m true # create a default 'mesh network' (on by default) --v false # create a default 'VPN network' (off by default) --c 7 # number of client configs to create (for VPN network, 5 by default) -``` +- [Learning Resources](https://netmaker.io/blog) # Why Netmaker + WireGuard? @@ -97,17 +81,6 @@ After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting - Netmaker with WireGuard can be highly customized for peer-to-peer, site-to-site, Kubernetes, and more. -# Get Support - -- [Community (Discord)](https://discord.gg/zRb9Vfhk8A) - -- [Community (Reddit)](https://reddit.com/r/netmaker) - - -- [Business (Subscription)](https://gravitl.com/plans/business) - -- [Learning Resources](https://gravitl.com/resources) - # Community Projects - [Netmaker + Traefik Proxy](https://github.com/bsherman/netmaker-traefik)