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.

## About

A quick overview of Netmaker, explaining what it is, how it works, and why you should be using it.

- About
  - What is Netmaker?
  - How Does Netmaker Work?
  - Use Cases for Netmaker

## Architecture

A technical overview of Netmaker, including design decisions and limitations.

- Architecture
  - Core Concepts
  - Components
  - Technical Process
  - Compatible Systems for Netclient
  - Limitations

## Install

Choose the right install method for you.

- Install

## Quick Start

A quick start guide to getting up and running with Netmaker and WireGuard as quickly as possible.

- Quick Install
  - Introduction
  - 0. Prerequisites
  - 1. Prepare DNS
  - 2. Install Dependencies
  - 3. Open Firewall
  - 4. Install Netmaker

- Getting Started
  - Setup
  - Deploy Nodes
  - Manage Nodes
  - Uninstalling the netclient
  - Uninstalling Netmaker

## Quick Start Nginx (depreciated)

An older guide to getting up and running with Netmaker using Nginx as quickly as possible.

- Install with Nginx (depreciated)

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

## Oauth Configuration

A simple guide to configuring OAuth for Netmaker.

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

## Client Installation

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

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

## External Clients

A detailed guide to give clients outside of the Netmaker network access to network resources.

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

## Guides

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

- Using Netmaker
  - External Tutorials

## API Reference

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

Coming Soon: Swagger Documentation

- API Reference

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