# Netmaker ## Netmaker - [Getting Started](https://learn.netmaker.io/getting-started.md): Helpful resources to get you started on your journey with Netmaker. - [About](https://learn.netmaker.io/getting-started/about.md) - [Architecture](https://learn.netmaker.io/getting-started/about/architecture.md) - [Client Types](https://learn.netmaker.io/getting-started/about/client-types.md) - [How it Works](https://learn.netmaker.io/getting-started/about/how-it-works.md) - [0. Overview](https://learn.netmaker.io/getting-started/about/how-it-works/0.-overview.md) - [1. Define Networks](https://learn.netmaker.io/getting-started/about/how-it-works/1.-define-networks.md) - [2. Add Devices](https://learn.netmaker.io/getting-started/about/how-it-works/2.-add-devices.md) - [3. Configure Routing](https://learn.netmaker.io/getting-started/about/how-it-works/3.-configure-routing.md) - [4. Grant User Access](https://learn.netmaker.io/getting-started/about/how-it-works/4.-grant-user-access.md) - [Glossary](https://learn.netmaker.io/getting-started/about/glossary.md) - [Quick Start](https://learn.netmaker.io/getting-started/quick-start.md) - [Platform Installation](https://learn.netmaker.io/getting-started/quick-start/platform-installation.md) - [Setup Guide](https://learn.netmaker.io/getting-started/quick-start/setup-guide.md): This guide will give you a short introduction to the functionalities of the Netmaker platform, after installing your control plane. - [Remote Access Quick Start](https://learn.netmaker.io/getting-started/quick-start/remote-access-quick-start.md) - [Walkthrough](https://learn.netmaker.io/getting-started/walkthrough.md) - [How to Install Netmaker](https://learn.netmaker.io/getting-started/walkthrough/how-to-install-netmaker.md) - [How to Create Networks](https://learn.netmaker.io/getting-started/walkthrough/how-to-create-networks.md) - [How to Add Devices](https://learn.netmaker.io/getting-started/walkthrough/how-to-add-devices.md) - [How to Add Egress](https://learn.netmaker.io/getting-started/walkthrough/how-to-add-egress.md) - [How to Create and Configure Gateways](https://learn.netmaker.io/getting-started/walkthrough/how-to-create-and-configure-gateways.md) - [How to Set DNS](https://learn.netmaker.io/getting-started/walkthrough/how-to-set-dns.md) - [How to Add Users](https://learn.netmaker.io/getting-started/walkthrough/how-to-add-users.md) - [How to Manage Access Controls - ACLs](https://learn.netmaker.io/getting-started/walkthrough/how-to-manage-access-controls-acls.md) - [How to View Metrics and Audit Logs](https://learn.netmaker.io/getting-started/walkthrough/how-to-view-metrics-and-audit-logs.md) - [Server and Client Management](https://learn.netmaker.io/getting-started/server-and-client-management.md) - [Server Installation](https://learn.netmaker.io/getting-started/server-and-client-management/server-installation.md) - [Advanced Options](https://learn.netmaker.io/getting-started/server-and-client-management/server-installation/advanced-options.md) - [Adding a Pro License to your Server](https://learn.netmaker.io/getting-started/server-and-client-management/server-installation/adding-a-pro-license-to-your-server.md) - [HA installation on Kubernetes](https://learn.netmaker.io/getting-started/server-and-client-management/server-installation/ha-installation-on-kubernetes.md) - [UI Branding](https://learn.netmaker.io/getting-started/server-and-client-management/server-installation/ui-branding.md) - [Client Installation](https://learn.netmaker.io/getting-started/server-and-client-management/client-installation.md) - [Netclient Installation](https://learn.netmaker.io/getting-started/server-and-client-management/client-installation/netclient-installation.md) - [Advanced Netclient Installation](https://learn.netmaker.io/getting-started/server-and-client-management/client-installation/netclient-installation/advanced-netclient-installation.md) - [Stabilize Netclient Connections Behind NAT](https://learn.netmaker.io/getting-started/server-and-client-management/client-installation/netclient-installation/stabilize-netclient-connections-behind-nat.md) - [Native WireGuard Installation](https://learn.netmaker.io/getting-started/server-and-client-management/client-installation/native-wireguard-installation.md) - [Netmaker Desktop Installation](https://learn.netmaker.io/getting-started/server-and-client-management/client-installation/netmaker-desktop-installation.md) - [Mobile App Installation](https://learn.netmaker.io/getting-started/server-and-client-management/client-installation/mobile-app-installation.md) - [Upgrading your Client and Server](https://learn.netmaker.io/getting-started/server-and-client-management/upgrading-your-client-and-server.md) - [Operations Field Guide](https://learn.netmaker.io/getting-started/operations-field-guide.md) - [Introduction and Index](https://learn.netmaker.io/getting-started/operations-field-guide/introduction-and-index.md) - [Networking Scenarios, VPN Types, and Terminology](https://learn.netmaker.io/getting-started/operations-field-guide/networking-scenarios-vpn-types-and-terminology.md) - [Netmaker Server Deployment](https://learn.netmaker.io/getting-started/operations-field-guide/netmaker-server-deployment.md) - [Network Setup](https://learn.netmaker.io/getting-started/operations-field-guide/network-setup.md) - [Planning Your Endpoints](https://learn.netmaker.io/getting-started/operations-field-guide/planning-your-endpoints.md) - [Deploying the Netclient](https://learn.netmaker.io/getting-started/operations-field-guide/deploying-the-netclient.md) - [Giving the Netclient Networking Functions](https://learn.netmaker.io/getting-started/operations-field-guide/giving-the-netclient-networking-functions.md) - [Deploying Static WireGuard](https://learn.netmaker.io/getting-started/operations-field-guide/deploying-static-wireguard.md) - [DNS](https://learn.netmaker.io/getting-started/operations-field-guide/dns.md) - [Access Controls - ACLs](https://learn.netmaker.io/getting-started/operations-field-guide/access-controls-acls.md) - [Site-to-Site and Routers](https://learn.netmaker.io/getting-started/operations-field-guide/site-to-site-and-routers.md) - [Granting Access to Your VPN](https://learn.netmaker.io/getting-started/operations-field-guide/granting-access-to-your-vpn.md) - [Accessing the VPN as an End User](https://learn.netmaker.io/getting-started/operations-field-guide/accessing-the-vpn-as-an-end-user.md) - [Troubleshooting](https://learn.netmaker.io/getting-started/operations-field-guide/troubleshooting.md) - [Monitoring your Network](https://learn.netmaker.io/getting-started/operations-field-guide/monitoring-your-network.md) - [Feature Matrix](https://learn.netmaker.io/getting-started/feature-matrix.md) - [Features](https://learn.netmaker.io/features.md): This sect highlights the features in Netmaker that enhance network management, security, and performance. It includes tools to simplify management, optimize connectivity, control access, enhance - [Mesh Overlay](https://learn.netmaker.io/features/mesh-overlay.md): Secure Mesh Overlay for Hybrid & Zero Trust Infrastructure - [Multi Network Segmentation](https://learn.netmaker.io/features/multi-network-segmentation.md): Network Segmentation & Multi-Overlay Architecture - [ACLs - Access Controls](https://learn.netmaker.io/features/acls-access-controls.md) - [Tag Management](https://learn.netmaker.io/features/tag-management.md) - [Egress](https://learn.netmaker.io/features/egress.md): secure network routing to access private and external networks - [DNS](https://learn.netmaker.io/features/dns.md) - [Gateways](https://learn.netmaker.io/features/gateways.md) - [User Management](https://learn.netmaker.io/features/user-management.md) - [Keys](https://learn.netmaker.io/features/keys.md): Create, manage, and control enrollment keys used for secure device on-boarding across networks. - [Multi-Factor Authentication](https://learn.netmaker.io/features/multi-factor-authentication.md) - [Conditional Access](https://learn.netmaker.io/features/conditional-access.md) - [Posture Checks](https://learn.netmaker.io/features/conditional-access/posture-checks.md) - [Device Approvals](https://learn.netmaker.io/features/conditional-access/device-approvals.md): Defines how devices are approved and join a network - [Just In Time Access](https://learn.netmaker.io/features/conditional-access/just-in-time-access.md): Part of the Enterprise Plan, ideal for organizations requiring more flexibility - [Telemetry and Logging](https://learn.netmaker.io/features/telemetry-and-logging.md) - [Metrics](https://learn.netmaker.io/features/telemetry-and-logging/metrics.md) - [Activity](https://learn.netmaker.io/features/telemetry-and-logging/activity.md) - [User Logs](https://learn.netmaker.io/features/telemetry-and-logging/activity/user-logs.md) - [Network Flow Logs](https://learn.netmaker.io/features/telemetry-and-logging/activity/network-flow-logs.md): Detect suspicious activity, troubleshoot network issues, and identify security risks with detailed traffic analysis for faster resolution and better protection - [SIEM Integration](https://learn.netmaker.io/features/telemetry-and-logging/activity/siem-integration.md) - [NMCTL](https://learn.netmaker.io/features/nmctl.md) - [Kubernetes Operator](https://learn.netmaker.io/kubernetes-operator.md) - [Netmaker SaaS](https://learn.netmaker.io/netmaker-saas.md) - [Overview](https://learn.netmaker.io/netmaker-saas/overview.md) - [Account Management](https://learn.netmaker.io/netmaker-saas/account-management.md) - [FAQ](https://learn.netmaker.io/netmaker-saas/faq.md) - [How To Guides](https://learn.netmaker.io/how-to-guides.md) - [Identity Provider Integration Guide](https://learn.netmaker.io/how-to-guides/identity-provider-integration-guide.md) - [Netmaker Desktop - Intune Deployment Guide](https://learn.netmaker.io/how-to-guides/netmaker-desktop-intune-deployment-guide.md): This guide walks you through deploying Netmaker Desktop to Windows devices using Microsoft Intune, including automatic configuration and startup. - [Integrating Non-native Devices](https://learn.netmaker.io/how-to-guides/integrating-non-native-devices.md) - [How To Run Netclient On OpenWRT](https://learn.netmaker.io/how-to-guides/how-to-run-netclient-on-openwrt.md) - [How to Setup a Full Mesh Site-to-Site VPN with Netmaker](https://learn.netmaker.io/how-to-guides/how-to-setup-a-full-mesh-site-to-site-vpn-with-netmaker.md) - [How to Secure IT Operations with Netmaker](https://learn.netmaker.io/how-to-guides/how-to-secure-it-operations-with-netmaker.md) - [Generate Config Files using API and NMCTL](https://learn.netmaker.io/how-to-guides/generate-config-files-using-api-and-nmctl.md) - [Stabilize Netclient Connections Behind NAT](https://learn.netmaker.io/how-to-guides/stabilize-netclient-connections-behind-nat.md) - [Securely Interconnecting EC2 Instances Across Private Amazon VPC Subnets Using Netmaker](https://learn.netmaker.io/how-to-guides/securely-interconnecting-ec2-instances-across-private-amazon-vpc-subnets-using-netmaker.md) - [NAT Traversal](https://learn.netmaker.io/how-to-guides/nat-traversal.md) - [External Guides](https://learn.netmaker.io/how-to-guides/external-guides.md) - [How to Use Netmaker with a Reverse Proxy](https://learn.netmaker.io/how-to-guides/how-to-use-netmaker-with-a-reverse-proxy.md) - [Set up a Static IP User VPN for Whitelisting, with WireGuard and Netmaker](https://learn.netmaker.io/how-to-guides/set-up-a-static-ip-user-vpn-for-whitelisting-with-wireguard-and-netmaker.md) - [Remote Access VPN to Azure with WireGuard](https://learn.netmaker.io/how-to-guides/remote-access-vpn-to-azure-with-wireguard.md) - [Create AWS Remote Access VPN with WireGuard - deprecated](https://learn.netmaker.io/how-to-guides/create-aws-remote-access-vpn-with-wireguard-deprecated.md) - [How to deploy a single Kubernetes cluster across multiple clouds using k3s and WireGuard - deprecate](https://learn.netmaker.io/how-to-guides/how-to-deploy-a-single-kubernetes-cluster-across-multiple-clouds-using-k3s-and-wireguard-deprecate.md) - [Mastering ACLs in Netmaker](https://learn.netmaker.io/how-to-guides/mastering-acls-in-netmaker.md) - [Building Zero-Trust Networks for Edge Devices with Netmaker](https://learn.netmaker.io/how-to-guides/building-zero-trust-networks-for-edge-devices-with-netmaker.md) - [How to setup a Self Hosted VPN using Wireguard and Netmaker - deprecated](https://learn.netmaker.io/how-to-guides/how-to-setup-a-self-hosted-vpn-using-wireguard-and-netmaker-deprecated.md) - [Setting Up Network Flow Logs on an On-Prem Netmaker Installation](https://learn.netmaker.io/how-to-guides/setting-up-network-flow-logs-on-an-on-prem-netmaker-installation.md) - [Help Articles](https://learn.netmaker.io/help-articles.md) - [SaaS](https://learn.netmaker.io/help-articles/saas.md) - [Egressing WireGuard Clients](https://learn.netmaker.io/help-articles/egressing-wireguard-clients.md) - [How to find Server URL or Tenant ID](https://learn.netmaker.io/help-articles/how-to-find-server-url-or-tenant-id.md) - [How to Close My Account and Cancel My Subscription?](https://learn.netmaker.io/help-articles/how-to-close-my-account-and-cancel-my-subscription.md): Closing your Netmaker account is a straightforward process - [Differences Between Netmaker On-Prem and SaaS](https://learn.netmaker.io/help-articles/differences-between-netmaker-on-prem-and-saas.md) - [How to Change Your Device Listen Port](https://learn.netmaker.io/help-articles/how-to-change-your-device-listen-port.md) - [What is Managed Endpoint and What Can I Use it For?](https://learn.netmaker.io/help-articles/what-is-managed-endpoint-and-what-can-i-use-it-for.md) - [What is LAN routing?](https://learn.netmaker.io/help-articles/what-is-lan-routing.md) - [Egress route conflict with local network route](https://learn.netmaker.io/help-articles/egress-route-conflict-with-local-network-route.md) - [Connection Refused Error Upon Restarting the Netmaker Server](https://learn.netmaker.io/help-articles/connection-refused-error-upon-restarting-the-netmaker-server.md) - [How can I know when new server updates are available?](https://learn.netmaker.io/help-articles/how-can-i-know-when-new-server-updates-are-available.md) - [What is a Tenant on SaaS?](https://learn.netmaker.io/help-articles/what-is-a-tenant-on-saas.md) - [NMCTL with SaaS Tenants](https://learn.netmaker.io/help-articles/nmctl-with-saas-tenants.md) - [Changing network profile to private on Windows](https://learn.netmaker.io/help-articles/changing-network-profile-to-private-on-windows.md) - [How to Update Your Payment Method](https://learn.netmaker.io/help-articles/how-to-update-your-payment-method.md) - [What are Static Devices in Netmaker?](https://learn.netmaker.io/help-articles/what-are-static-devices-in-netmaker.md) - [Netclient could not work together with Zerotier on Windows](https://learn.netmaker.io/help-articles/netclient-could-not-work-together-with-zerotier-on-windows.md) - [What Are Default Devices in Netmaker?](https://learn.netmaker.io/help-articles/what-are-default-devices-in-netmaker.md) - [Can't Reach External Network or Device Via an Egressing External Client](https://learn.netmaker.io/help-articles/cant-reach-external-network-or-device-via-an-egressing-external-client.md) - [Site-to-Site VPN with Mikrotik router using wg plugin](https://learn.netmaker.io/help-articles/site-to-site-vpn-with-mikrotik-router-using-wg-plugin.md) - [How to Change Your Login Method in Netmaker: A Step-by-Step Guide](https://learn.netmaker.io/help-articles/how-to-change-your-login-method-in-netmaker-a-step-by-step-guide.md) - [Integrating VPN Routers and Firewall Appliances into Netmaker](https://learn.netmaker.io/help-articles/integrating-vpn-routers-and-firewall-appliances-into-netmaker.md) - [How to Add Company and Address Details to Your Invoice in Netmaker](https://learn.netmaker.io/help-articles/how-to-add-company-and-address-details-to-your-invoice-in-netmaker.md) - [How to Transfer Tenant Ownership for On-Prem and SaaS Tenants](https://learn.netmaker.io/help-articles/how-to-transfer-tenant-ownership-for-on-prem-and-saas-tenants.md) - [Installing Netclient on a Windows OS with Wireguard dependency.](https://learn.netmaker.io/help-articles/installing-netclient-on-a-windows-os-with-wireguard-dependency..md) - [The Guide for OPNsense Integration Doesn't Work](https://learn.netmaker.io/help-articles/the-guide-for-opnsense-integration-doesnt-work.md) - [How to add billing address on my invoice?](https://learn.netmaker.io/help-articles/how-to-add-billing-address-on-my-invoice.md) - [Netclient Throwing 'Segmentation Errors' on Linux](https://learn.netmaker.io/help-articles/netclient-throwing-segmentation-errors-on-linux.md) - [Making OpenWRT Successfully Integrate with the Netmaker Network](https://learn.netmaker.io/help-articles/making-openwrt-successfully-integrate-with-the-netmaker-network.md) - [Setup and Install Docker Netclient on OpenWRT](https://learn.netmaker.io/help-articles/setup-and-install-docker-netclient-on-openwrt.md) - [API Spec](https://learn.netmaker.io/api-spec.md) - [DNS](https://learn.netmaker.io/api-spec/dns.md) - [Config Files](https://learn.netmaker.io/api-spec/config-files.md) - [IP Service](https://learn.netmaker.io/api-spec/ip-service.md) - [Hosts](https://learn.netmaker.io/api-spec/hosts.md) - [Auth](https://learn.netmaker.io/api-spec/auth.md) - [IDP](https://learn.netmaker.io/api-spec/idp.md) - [Metrics](https://learn.netmaker.io/api-spec/metrics.md) - [Networks](https://learn.netmaker.io/api-spec/networks.md) - [Nodes](https://learn.netmaker.io/api-spec/nodes.md) - [Gateways](https://learn.netmaker.io/api-spec/gateways.md) - [Server](https://learn.netmaker.io/api-spec/server.md) - [Users](https://learn.netmaker.io/api-spec/users.md) - [ACL](https://learn.netmaker.io/api-spec/acl.md) - [Activity](https://learn.netmaker.io/api-spec/activity.md) - [Egress](https://learn.netmaker.io/api-spec/egress.md) - [EnrollmentKeys](https://learn.netmaker.io/api-spec/enrollmentkeys.md) - [Traffic Logs](https://learn.netmaker.io/api-spec/traffic-logs.md) - [JIT](https://learn.netmaker.io/api-spec/jit.md) - [Auto Relay](https://learn.netmaker.io/api-spec/auto-relay.md) - [Posture Check](https://learn.netmaker.io/api-spec/posture-check.md) - [TAG](https://learn.netmaker.io/api-spec/tag.md) - [Models](https://learn.netmaker.io/api-spec/models.md) - [References](https://learn.netmaker.io/references.md) - [User Interface](https://learn.netmaker.io/references/user-interface.md) - [API](https://learn.netmaker.io/references/api.md) - [NMCTL](https://learn.netmaker.io/references/nmctl.md) - [FAQ](https://learn.netmaker.io/references/faq.md) - [Troubleshooting](https://learn.netmaker.io/references/troubleshooting.md) - [Code of Conduct](https://learn.netmaker.io/code-of-conduct.md) - [License](https://learn.netmaker.io/license.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://learn.netmaker.io/getting-started.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.