Skip to content

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

For Kubernetes-specific guidance, please see the Netmaker Kubernetes Documentation.

## About

High-level information about what Netmaker is and how it works.

- About
  - What is Netmaker?
  - How Does Netmaker Work?
  - Use Cases for Netmaker
- Architecture
  - Core Concepts
  - Components
  - Technical Process
  - Compatible Systems for Netclient
  - Limitations

## Getting Started

How to install Netmaker and set up your first network.

- Install
- Quick Install
  - Introduction
  - 0. Prerequisites
  - 1. Prepare DNS
  - 2. Install Dependencies
  - 3. Open Firewall
  - 4. Install Netmaker
- Getting Started
  - Setup
  - Create a Network
  - Create a Key
  - Deploy Nodes
  - Manage Nodes
  - Uninstalling the netclient
  - Uninstalling Netmaker

## Ingress, Egress, and Relays

How to give machines outside of the Netmaker network access to network resources via an Ingress Gateway:

- Ingress + External Clients
  - Introduction
  - Configuring an Ingress Gateway
  - Adding Clients to a Gateway
  - Configuring DNS for Ext Clients (OPTIONAL)

How to give machines inside the Netmaker network access to external network resources via an Egress Gateway:

- Egress Gateway
  - Introduction
  - Configuring an Egress Gateway
  - Use Cases

How to make machines inside the network reachable if they are blocked by NAT/Firewall:

- Relay Servers
  - Introduction
  - Configuring a Relay

## Kubernetes Documentation

- Kubernetes

Netmaker Kubernetes Documentation

## Advanced Server Installation

A detailed guide to installing the Netmaker server (API, DB, UI, DNS), and configuration options.

- Advanced Server Installation
  - System Compatibility
  - Server Configuration Reference
  - DNS Mode Setup
  - Docker Compose Install
  - Linux Install without Docker
  - Kubernetes Install
  - Nginx Reverse Proxy Setup with https
  - Highly Available Installation (Kubernetes)
  - Highly Available Installation (VMs/Bare Metal)

## Advanced Client Installation

A detailed guide to installing the Netmaker agent (netclient) on devices and configuration options.

- Advanced Client Installation
  - Introduction to Netclient
  - Notes on Windows
  - Notes on OpenWRT
  - Modes and System Compatibility
  - Prerequisites
  - Configuration
  - Installation
  - Managing Netclient

## Oauth Configuration

A simple guide to configuring OAuth for Netmaker.

- Integrating OAuth
  - Introduction
  - Configuring your provider
  - Configuring Netmaker
  - Configuring User Permissions

## External Guides

A handful of guides for use cases including site-to-site, Kubernetes, private DNS, and more.

- External Guides
  - Video Tutorials
  - Written Tutorials

## UI Reference

A reference document for the Netmaker Server UI, with annotated screenshot detailing each field.

- UI Reference
  - Dashboard
  - Networks
  - Nodes
  - Ext Clients
  - DNS
  - Create / Edit Users

## API Reference

A reference document for the Netmaker Server API, and example API calls for various use cases.

- API Reference

## Upgrades

Upgrading the Netmaker server and clients.

- Upgrades

## Troubleshooting

Help with common Netmaker/netclient issues.

- Troubleshooting
  - Common Issues
  - Server
  - UI
  - Netclient
  - CoreDNS

## Support

Where to go for help, and a FAQ.

- Support
  - FAQ
  - Telemetry
  - Contact

## Code of Conduct

A statement on our expectations and pledge to the community.

- Code of Conduct
  - Our Pledge
  - Our Standards
  - Our Responsibilities
  - Scope
  - Enforcement
  - Attribution

## Licensing

A link to the Netmaker license.

- License