README
¶
WireGuard® automation from homelab to enterprise
| Create | Manage | Automate |
|---|---|---|
| ✔ WireGuard Networks | ✔ Admin UI | ✔ Linux |
| ✔ Remote Access Gateways | ✔ OAuth | ✔ Docker |
| ✔ Mesh VPNs | ✔ Private DNS | ✔ Mac |
| ✔ Site-to-Site | ✔ Access Control Lists | ✔ Windows |
Try Netmaker SaaS
If you're looking for a managed service, you can get started with just few clicks, visit netmaker.io to create your netmaker server.
Self-Hosted Quick Start
These are the instructions for deploying a Netmaker server on your own cloud VM as quickly as possible. For more detailed instructions, visit the Install Docs.
- Get a cloud VM with Ubuntu 22.04 and a public IP.
- Open ports 443, 80, 3479, 8089 and 51821-51830/udp on the VM firewall and in cloud security settings.
- (recommended) Prepare DNS - Set a wildcard subdomain in your DNS settings for Netmaker, e.g. *.netmaker.example.com, which points to your VM's public IP.
- Run the script:
sudo wget -qO /root/nm-quick.sh https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh && sudo chmod +x /root/nm-quick.sh && sudo /root/nm-quick.sh
This script by default installs PRO version with 14-day trial, check out these instructions for post trial period https://docs.netmaker.io/install.html#after-trial-period-ends. It also gives you the option to use your own domain (recommended) or an auto-generated domain.
After installing Netmaker, check out the Walkthrough and Getting Started guides to learn more about configuring networks. Or, check out some of our other Tutorials for different use cases, including Kubernetes.
Get Support
Why Netmaker + WireGuard?
-
Netmaker automates virtual networks between data centers, clouds, and edge devices, so you don't have to.
-
Kernel WireGuard offers maximum speed, performance, and security.
-
Netmaker is built to scale from the small business to the enterprise.
-
Netmaker with WireGuard can be highly customized for peer-to-peer, site-to-site, Kubernetes, and more.
Community Projects
Disclaimer
WireGuard is a registered trademark of Jason A. Donenfeld.
License
Netmaker's source code and all artifacts in this repository are freely available. All content that resides under the "pro/" directory of this repository, if that directory exists, is licensed under the license defined in "pro/LICENSE". All third party components incorporated into the Netmaker Software are licensed under the original license provided by the owner of the applicable component. Content outside of the above mentioned directories or restrictions above is available under the "Apache Version 2.0" license as defined below. All details for the licenses used can be found here: LICENSE.md.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Environment file for getting variables Currently the only thing it does is set the master password Should probably have it take over functions from OS such as port and mongodb connection details Reads from the config/environments/dev.yaml file by default
|
Environment file for getting variables Currently the only thing it does is set the master password Should probably have it take over functions from OS such as port and mongodb connection details Reads from the config/environments/dev.yaml file by default |
|
Package classification Netmaker
|
Package classification Netmaker |
|
package for logicing client and server code
|
package for logicing client and server code |
|
TODO: Either add a returnNetwork and returnKey, or delete this
|
TODO: Either add a returnNetwork and returnKey, or delete this |
|
netclient
|
|
|
pro
|
|