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

## Quick Start

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

- Quick Start
  - Introduction
  - Prerequisites
  - Install
  - Setup
  - Deploy Nodes
  - Manage Nodes
  - Uninstalling the netclient
  - Uninstralling Netmaker

## Server Installation

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

- Server Installation
  - Notes on Optional Features
  - System Compatibility
  - DNS Mode Prereqisite Setup
  - Docker Compose Install
  - Linux Install without Docker
  - Kubernetes Install
  - Configuration Reference

## Client Installation

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

- Client Installation
  - Introduction to Netclient
  - 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

## Guides

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

- Using Netmaker
  - External Tutorials
  - Basic
  - Local Network
  - Site-to-Site
  - Dual Stack with IPv6
  - Kubernetes Node Network

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

## Support

Where to go for help, and a FAQ.

- Support
  - FAQ
  - Issues, Bugs, and Feature Requests
  - Contact

## Contributing

A guide on how to contribute to the Netmaker project.

- Contribute
  - Submitting an Issue
  - Submitting an Enhancement
  - Contributing Code
    - Forking
    - Building
    - Testing
    - Submitting a PR

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