DocsAPI

Netmaker Professional Setup

This guide explains how to set up Netmaker Professional, which offers advanced business features beyond the Community Edition. Explore the comparison and pricing details on our pricing page.

Netmaker Professional builds on the Community Edition with advanced features tailored for business needs.

Key DifferencesCopied!

The Community Edition (CE) is designed for basic VPN setups, offering features like an integrated DNS server and egress traffic to external networks. It is open-source and ideal for small deployments or developers, but lacks advanced features like Full-Tunnel Gateways, Dedicated Traffic Relays, and Remote Access Clients. It also supports only admin users with no segmentation for non-admins. The Professional Edition (SaaS & On-Prem) is built for enterprises, providing advanced features such as Dedicated Traffic Relays, Network Traffic Metrics, Access Control, OAuth integration, and the ability to create non-admin users. It also includes features like Failovers, Relays, and Full-Tunnel Internet Gateways for enhanced control and scalability. For a detailed overview of features in both the Pro and Community Editions, check it out here.

Pro-Specific FunctionalitiesCopied!

  • User Management:

    • In CE, only admin users can be created.

    • In Pro, you can create non-admin users, enabling user segmentation with remote access gateways.

  • OAuth Integration:

    • Netmaker Professional allows login via OAuth providers, offering a secure alternative to simple auth.

  • Remote Access Client:

    • Connect to your network from anywhere via a laptop or mobile device, enhancing remote work capabilities.

  • Failovers:

    • Helps two peers communicate despite firewall restrictions, by rerouting traffic through user-defined failover nodes.

  • Relays:

    • Routes traffic for relayed devices via a designated relay node within the network.

  • Internet Gateways:

    • Acts as a traditional VPN, supporting both mesh network hosts and remote devices.

  • Enhanced ACLs (Access Control Lists):

    • Define communication rules for devices and manage user access for improved network security.

  • Tag Management:

    • Group devices using tags to simplify network management and boost operational efficiency.

  • Network Metrics:

    • Collects data like latency, transfer rates, and connectivity status.

    • Displays metrics in the Netmaker UI and exports them to Grafana via Prometheus.

Obtain License in Few StepsCopied!

Signup here https://account.netmaker.io/signup to get a license for your self-hosted Netmaker.

Whether using a business or personal email, we recommend taking advantage of our 7-day free trial. For business emails, no credit card is required!

Enter your email address and set a password. You also have the option to continue using your Google, GitHub, or Microsoft account.

Afterward, you will receive a verification link sent to your email address.

Open your inbox and click on Verify My Email to complete the process.

Afterward, you will be verified and redirected to the deployment page, in this guide, we will proceed with the on-premise setup.

Following this, a tenant will be created for you automatically.

Click on the Manage Tenant button to view its details.

Set Up Your Netmaker Pro ServerCopied!

Initially, you will need the License Key and Tenant ID, which can be found under the Settings tab.

Once you have your license key and tenant ID, you can get the nm-quick installer and run it.

sudo wget -qO /root/nm-quick.sh https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh && sudo chmod +x /root/nm-quick.sh && sudo /root/nm-quick.sh -p

Follow the prompts for a pro edition server and provide the License Key and Tenant ID when prompted.

Upgrade from Community Edition to ProCopied!

You can upgrade from an existing community server to a pro server with the same script. Just fetch the latest version and run it.

sudo wget -qO /root/nm-quick.sh https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh && sudo chmod +x /root/nm-quick.sh && sudo /root/nm-quick.sh -u

Follow the prompts to setup a pro server and the script will make the necessary changes to your netmaker.env file and grab the pro docker-compose.override.yml file.

If you prefer to upgrade manually, go to your netmaker server and add the following to your netmaker.env file:

LICENSE_KEY=<license key>
NETMAKER_TENANT_ID=<tenant id>

Also change SERVER_IMAGE_TAG in netmaker.env to <version>-ee. For example: SERVER_IMAGE_TAG=v0.25.0-ee

Also change the INSTALL_TYPE from ce to pro.

Then you will need to get the docker-compose pro file from here

wget -O /root/docker-compose.override.yml https://raw.githubusercontent.com/gravitl/netmaker/master/compose/docker-compose.pro.yml

No changes will need to be made to that file. It will use the configs listed in your netmaker.env file.

After that run the following command:

docker kill netmaker netmaker-ui && docker compose up -d

When you browse to your self-hosted Netmaker via dashboard.<YOUR_BASE_DOMAIN>, you should see the professional UI and a new Dashboard. The top menu bar will have relays and metrics added.

new dashboard

(Optional) Setup your server for Prometheus and GrafanaCopied!

If you would like to use Netmaker’s custom Prometheus exporter and Grafana dashboard, your docker-compose.override.yml file will already have those section.

In Netmaker.env, change the following:

METRICS_EXPORTER=on
PROMETHEUS=on

Previous Page

UI Branding

Next Page

0. Overview