References

UI

Annotated screenshots of most UI components, detailing the configuration options of each field across Nodes, Networks, DNS, Ext Clients, Users, and more.

• Authentication
  • Signup
  • Login
• Dashboard
• Networks
  • Create
• Hosts
  • Host List
  • Host Create
  • Host Details
• Nodes
  • Node List
  • Create Egress
  • Create Relay
  • Edit Node / Node Details
• Remote Access
• DNS
• Create / Edit Users
• Node Graph
• Access Control Lists

API

Netmaker can be run without the UI, and all functions can be achieved via API calls

• API Usage
• Authentication
• Format of Calls for curl
• API Documentation

Netclient

Netclient manages WireGuard on client devices (nodes)

• Netclient
  • Installation
  • Joining a Network
  • Managing Netclient
  • Uninstalling

NMCTL

nmctl is a CLI tool for interacting with the Netmaker API

• NMCTL
  • Quick Start
• NMCTL - how to use netmaker from command line
  • Assumptions
  • Setup superadmin user
  • Normal Operations by user
  • Set username/password
  • Set User Context
  • Create Network
  • Create Enrollment Key
  • Join network

FAQ

Frequently Asked Questions

• FAQ
  • Is Netmaker a VPN like NordVPN?
  • Do you have an ‘Exit Nodes’ feature?
  • Do you offer any business or professional support?

Troubleshooting

• Troubleshooting
  • Common Issues
  • Server
  • MQ
  • UI
  • Netclient
  • CoreDNS