Browse Source

updated readme

afeiszli 3 years ago
parent
commit
21bd64e35d
1 changed files with 17 additions and 44 deletions
  1. 17 44
      README.md

+ 17 - 44
README.md

@@ -17,7 +17,7 @@
 
 
 <p align="center">
 <p align="center">
   <a href="https://github.com/gravitl/netmaker/releases">
   <a href="https://github.com/gravitl/netmaker/releases">
-    <img src="https://img.shields.io/badge/Version-0.14.4-informational?style=flat-square" />
+    <img src="https://img.shields.io/badge/Version-0.14.5-informational?style=flat-square" />
   </a>
   </a>
   <a href="https://hub.docker.com/r/gravitl/netmaker/tags">
   <a href="https://hub.docker.com/r/gravitl/netmaker/tags">
     <img src="https://img.shields.io/docker/pulls/gravitl/netmaker?label=downloads" />
     <img src="https://img.shields.io/docker/pulls/gravitl/netmaker?label=downloads" />
@@ -41,51 +41,35 @@
 
 
 # WireGuard<sup>®</sup> automation from homelab to enterprise
 # WireGuard<sup>®</sup> 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  
 # Get Started in 5 Minutes  
 
 
-**For DigitalOcean, use the 1-Click App:** <a href="https://marketplace.digitalocean.com/apps/netmaker?refcode=496ffcf1e252"><img src="https://www.deploytodo.com/do-btn-blue.svg" width="15%" /></a>  
-**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 [email protected]`    
 
 
 <p float="left" align="middle">
 <p float="left" align="middle">
 <img src="./img/readme.gif" />
 <img src="./img/readme.gif" />
 </p>
 </p>
 
 
-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://gravitl.com/resources) 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://www.netmaker.io/blog) for different use cases, including Kubernetes.
 
 
-### Optional configurations
+# Get Support
 
 
-**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`  
+- [Discord](https://discord.gg/zRb9Vfhk8A)
 
 
-**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 [email protected]`  
+- [Reddit](https://reddit.com/r/netmaker)
 
 
-**Script Options**  
-```
-./nm-quick
--d domain.example.com # specify a wildcard domain for netmaker to use (DNS must point to this server)
--e [email protected] # 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?
 # 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.
 - 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
 # Community Projects
 
 
 - [Netmaker + Traefik Proxy](https://github.com/bsherman/netmaker-traefik)
 - [Netmaker + Traefik Proxy](https://github.com/bsherman/netmaker-traefik)