Welcome to the Netmaker Documentation¶
Netmaker is a platform for creating and managing fast, secure, and dynamic virtual overlay networks using WireGuard.
This documentation covers Netmaker’s installation, usage, troubleshooting, and customization, as well as reference documents for the API, UI and Agent configuration. All of the source code for Netmaker is on GitHub.
About¶
A quick overview of Netmaker, explaining what it is, how it works, and why you should be using it.
Architecture¶
A technical overview of Netmaker, including design decisions and limitations.
Quick Start¶
A quick start guide to getting up and running with Netmaker and WireGuard as quickly as possible.
Server Installation¶
A detailed guide to installing the Netmaker server (API, DB, UI, DNS), and configuration options.
Client Installation¶
A detailed guide to installing the Netmaker agent (netclient) on devices and configuration options.
External Clients¶
A detailed guide to give clients outside of the Netmaker network access to network resources.
Guides¶
A handful of guides for use cases including site-to-site, Kubernetes, private DNS, and more.
API Reference¶
A reference document for the Netmaker Server API, and example API calls for various use cases.
Coming Soon: Swagger Documentation
Troubleshooting¶
Help with common Netmaker/netclient issues.
Support¶
Where to go for help, and a FAQ.
Code of Conduct¶
A statement on our expectations and pledge to the community.
Licensing¶
A link to the Netmaker license.