netmaker README

The project's README from github.com/gravitl/netmaker. As one markdown file: README.md.

ROSS Index - Fastest Growing Open-Source Startups | Runa Capital Y-Combinator

WireGuard® automation from homelab to enterprise

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: Docker
: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

Try Netmaker SaaS

If you're looking for a managed service, you can get started with just a few clicks, visit netmaker.io to create your netmaker server.

Self-Hosted Open Source Quick Start

These are the instructions for deploying a Netmaker server on your cloud VM as quickly as possible. For more detailed instructions, visit the Install Docs.

  1. Get a cloud VM with Ubuntu 24.04 and a static public IP.
  2. Allow inbound traffic on port 443,51821 TCP and UDP to the VM firewall in cloud security settings, and for simplicity, allow outbound on All TCP and All UDP.
  3. (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.
  4. Run the script to setup open source version of Netmaker:

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

To Install Self-Hosted PRO Version - https://docs.netmaker.io/docs/server-installation/netmaker-professional-setup

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?

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/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.

netmaker (gravitl/netmaker)

Searching Database…

11.8K ·GitHub
Netmaker
What is this?Netmaker is a tool that automates creating and managing virtual networks (mesh VPNs, remote access gateways, site-to-site links) using WireGuard.
Is this a self-hosted server or a managed service?Both: you can self-host the open-source server on your own VM, or use the managed Netmaker SaaS at netmaker.io.
How do I get a self-hosted server running?Get an Ubuntu 24.04 cloud VM with a static public IP, open ports 443 and 51821 TCP/UDP, optionally set up a wildcard DNS subdomain, then run the nm-quick.sh install script.
What do I need before installing it?A cloud VM running Ubuntu 24.04 with a static public IP and firewall rules allowing inbound traffic on ports 443 and 51821 (TCP/UDP).
Are there any extra install steps for enterprise features?The free quick-start script sets up the open-source version; a separate PRO version install is required for enterprise features, and 'pro/' directory code uses a different license.
What scale is this meant for?It's designed to scale from homelab and small business setups up to enterprise deployments.
Which client OSes does Netmaker support?Netclient (the peer agent) supports Linux, Mac, and Windows, and the server itself runs as a Docker deployment.
Does my network traffic stay on my own infrastructure?Yes, when self-hosted, Netmaker runs on your own cloud VM and manages WireGuard tunnels directly between your own data centres, clouds, and edge devices.
Why use Netmaker instead of configuring WireGuard manually?Netmaker automates the creation, key management, and orchestration of WireGuard tunnels across many devices, which would otherwise require manual configuration per peer.
Does Netmaker use userspace or kernel WireGuard?It uses kernel WireGuard, which the project says offers maximum speed, performance, and security.
Can Netmaker integrate with Kubernetes?Yes, there are community projects and tutorials for using Netmaker with Kubernetes, including a Multi-Cluster K8S Plugin and Netmaker K3S setup.
Does it come with an admin interface and access control?Yes, it includes an Admin UI, OAuth login, private DNS, and Access Control Lists out of the box.
What are similar projects?netbird, algo, pangolin, SoftEtherVPN, tailscale, p2wlan, wireguard-install, streisand
Which topics is it in?ipv6-support, wireguard-vpn, mesh-network, zero-trust, vpn-server, k8s, devsecops, wireguard, dns, vpn, oauth, kubernetes
Creator
gravitl
Size
296.2 MB
Stars
11.8K
Updated
CommitOct 17Releasev1.7.0Aug 31
Age
5y
Commits · 90 Days