This quick install guide is an opinionated guide for getting up and running with Netmaker as quickly as possible.
If you are just looking to trial netmaker, we highly recommend using the 5-minute installer of Netmaker in the README on GitHub: https://github.com/gravitl/netmaker
The following is a guided version of that script, with the option to add a custom domain (instead of nip.io):
We assume for this installation that you want all of the Netmaker features enabled, and you want your server to be accessible from anywhere.
This instance will not be HA. However, it should comfortably handle 100+ concurrent clients and support the most common use cases.
If you are deploying for a business or enterprise use case and this setup will not fit your needs, please contact us: https://www.netmaker.org/contact
By the end of this guide, you will have Netmaker installed on a public VM linked to your custom domain, secured behind a Traefik reverse proxy.
For information about deploying more advanced configurations, see the Advanced Installation docs.
Preferably from a cloud provider (e.x: DigitalOcean, Linode, AWS, GCP, etc.)
We highly recommend that Netmaker be deployed in a dedicated networking environment. It should not share a local network with the clients which it will be managing. This can cause routing issues.
We do not recommend Oracle Cloud, as VM’s here have been known to cause network interference.
The machine should have a public, static IP address
The machine should have at least 1GB RAM and 1 CPU (2GB RAM preferred for production installs)
2GB+ of storage
Ubuntu 20.04 Installed
A publicly owned domain (e.x. example.com, mysite.biz)
Permission and access to modify DNS records via DNS service (e.x: Route53)
Note on Cloudflare: Many of our users use Cloudflare for DNS. Cloudflare has limitations on subdomains you must be aware of, which can cause issues once Netmaker is deployed. Cloudlare will also proxy connections, which MQ does not like. This can be disabled in the Cloudflare dashboard. If setting up your Netmaker server using Cloudflare for DNS, be aware that the configuration of Cloudflare may cause problems with Netmaker which must be resolved, and at this point, Netmaker is not providing guidance on this setup.
1. Prepare DNS¶
Create a wildcard A record pointing to the public IP of your VM. As an example, *.netmaker.example.com. Alternatively, create records for these specific subdomains:
2. Install Dependencies¶
ssh root@your-host sudo apt-get update sudo apt-get install -y docker.io docker-compose wireguard
At this point you should have all the system dependencies you need.
3. Open Firewall¶
Make sure firewall settings are set for Netmaker both on the VM and with your cloud security groups (AWS, GCP, etc).
Make sure the following ports are open both on the VM and in the cloud security groups:
443 (tcp): for Traefik, which proxies the Dashboard (UI), REST API (Netmaker Server), and Broker (MQTT)
51821-518XX (udp): for WireGuard - Netmaker needs one port per network, starting with 51821, so open up a range depending on the number of networks you plan on having. For instance, 51821-51830.
sudo ufw allow proto tcp from any to any port 443 && sudo ufw allow 51821:51830/udp
It is also important to make sure the server does not block forwarding traffic (it will do this by default on some providers). To ensure traffic will be forwarded:
iptables --policy FORWARD ACCEPT
- Again, based on your cloud provider, you may additionally need to set inbound security rules for your server (for instance, on AWS). This will be dependent on your cloud provider. Be sure to check before moving on:
allow 443/tcp from all
allow 51821-51830/udp from all
4. Install Netmaker¶
Prepare Docker Compose¶
ip route get 1 | sed -n 's/^.*src \([0-9.]*\) .*$/\1/p'
Now, insert the values for your base (wildcard) domain, public ip.
wget -O docker-compose.yml https://raw.githubusercontent.com/gravitl/netmaker/master/compose/docker-compose.yml sed -i 's/NETMAKER_BASE_DOMAIN/<your base domain>/g' docker-compose.yml sed -i 's/SERVER_PUBLIC_IP/<your server ip>/g' docker-compose.yml sed -i 's/YOUR_EMAIL/<your email>/g' docker-compose.yml
Generate a unique master key and insert it:
tr -dc A-Za-z0-9 </dev/urandom | head -c 30 ; echo '' sed -i 's/REPLACE_MASTER_KEY/<your generated key>/g' docker-compose.yml
You may want to save this key for future use with the API.
After v0.16.1 Your docker-compose file should also contain an environment variable for a Mosquitto password. You will need to set it with whatever password you like.
sed -i "s/REPLACE_MQ_ADMIN_PASSWORD/$MQ_ADMIN_PASSWORD/g" /root/docker-compose.yml
You must retrieve the MQ configuration file for Mosquitto.
wget -O /root/mosquitto.conf https://raw.githubusercontent.com/gravitl/netmaker/master/docker/mosquitto.conf
After v0.16.1 You will also need to grab the wait.sh file and make sure it is executable
wget -q -O /root/wait.sh https://raw.githubusercontent.com/gravitl/netmaker/develop/docker/wait.sh chmod +x wait.sh
sudo docker-compose up -d
navigate to dashboard.<your base domain> to begin using Netmaker.
To troubleshoot issues, start with:
docker logs netmaker
Or check out the troubleshoooting docs.