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 是一款工具,借助 WireGuard 自动完成虚拟网络(网状 VPN、远程访问网关、站点到站点连接)的创建与管理。
这是自托管的服务器,还是托管服务?两者都有:你可以在自己的虚拟机上自托管开源服务器,也可以使用托管的 Netmaker SaaS(netmaker.io)。
我要怎样才能跑起自托管服务器?准备一台带固定公网 IP 的 Ubuntu 24.04 云虚拟机,开放 443 端口和 51821 端口的 TCP/UDP 流量;可以选择设置通配符 DNS 子域名,然后运行 nm-quick.sh 安装脚本。
安装前我需要准备什么?一台运行 Ubuntu 24.04、带固定公网 IP 的云虚拟机,并且防火墙要允许 443 和 51821 端口(TCP/UDP)的入站流量。
企业功能还需要额外的安装步骤吗?免费的快速启动脚本只安装开源版本;企业功能需要另外安装 PRO 版本,而 'pro/' 目录下的代码使用不同的许可证。
这个产品面向什么规模?它的设计目标是从家庭实验室、小型企业的部署一直扩展到企业级部署。
Netmaker 支持哪些客户端操作系统?Netclient(对等节点代理程序)支持 Linux、Mac 和 Windows,服务器本身则以 Docker 方式部署运行。
我的网络流量会留在自己的基础设施内吗?会的。自托管时,Netmaker 运行在你自己的云虚拟机上,直接在你自己的数据中心、云和边缘设备之间管理 WireGuard 隧道。
为什么要用 Netmaker,而不是手动配置 WireGuard?Netmaker 可自动完成众多设备之间 WireGuard 隧道的创建、密钥管理和编排,否则就得为每个对等节点逐一手动配置。
Netmaker 用的是用户空间还是内核的 WireGuard?它使用内核版 WireGuard,项目方称其速度、性能和安全性都是最高的。
Netmaker 能和 Kubernetes 集成吗?可以。社区里有一些把 Netmaker 与 Kubernetes 配合使用的项目和教程,包括 Multi-Cluster K8S Plugin 和 Netmaker K3S 部署方案。
它自带管理界面和访问控制功能吗?有的。开箱即用,包含管理界面(Admin UI)、OAuth 登录、私有 DNS 和访问控制列表。
Creator
gravitl
Size
296.2 MB
Stars
11.8K
Age
5y
Commits · 90 Days