This guide covers how to get setup with Netmaker Enterprise.
Notes on Free Tier¶
Netmaker Enterprise includes a generous free tier, which should cover most use cases for individual users. To use Netmaker Enterprise with the free tier, simply follow the same instructions, but use the included license in your license dashboard, instead of buying one.
Free Tier License Limits:
Netmaker Servers: 1
Netmaker Users: 1
Ext Clients: 20
Get a License¶
Visit https://dashboard.license.netmaker.io to get a license. When you first visit the site, You should be prompted to create an account. After you make one, You will get a free tier licence key. You will also recieve an email that contains this key along with your user ID. Your keys can be found by clicking on the license key tab on the dashboard. Your user id can be found by clicking on the user profile tab on the side menu.
If you want to get a new key, You can click on the plans tab. You will be taken to a screen wich shows our plans we offer. The free tier is the one that is initially given when you create your account. You can upgrade to the paid tier on this page, or if you need more of an enterprise level plan, there is a button to contact us to set that up.
You will have the option of choosing to pay yearly or monthly. You will also see a layout of the cost of each node, server, user, and ext client.
Choose how many of each node, server, user, ext clients, that you need. You can also change these amounts in the license tab should you need to adjust those numbers later.
After a successful payment, you will get a confirmation email containing your new license key. The next section will show how to get that key and setup your server.
Setup your server¶
You will first need to get your license key and account ID. Your confirmation email after you make an account will have a license key for a free trial version and your user ID. The confirmation email after buying a licence will have your new license key.
You can also find your license keys in the license key tab. The copy icon on the left will copy the license key to your clipboard.
Also in this same tab, you can click on the license key and add or remove any servers, nodes, users, or ext clients to your plan.
Your user ID will be located in your user profile found on the side menu
Once you have your license key and account ID, go to your netmaker server and add the following to your docker-compose.yml environment variables.
LICENSE_KEY: “<license key>” NETMAKER_ACCOUNT_ID: "<account id>"
Also change the netmaker image to
image: gravitl/netmaker:<version>-ee. For example:
image: gravitl/netmaker:v0.16.0-ee After that
docker kill netmaker netmaker-ui && docker-compose up -d and you should see the enterprise UI on dashboard.<YOUR_BASE_DOMAIN>
You should see a new Dashboard with an Admin tab added. On the arrow will be tabs for the server logs and metrics.
(Optional) Setup your server for Prometheus and Grafana¶
If you would like to use Netmaker’s custom Prometheus exporter and Grafana dashboard, you must make some modifications to your docker-compose.
Use the EE Compose file as a reference:
You must add in sections (as in the above) for :
Additionally, you must make the following changes to Netmaker:
In Netmaker, Add the following env var: