Skip to content

Commit

Permalink
modifying prereq section
Browse files Browse the repository at this point in the history
  • Loading branch information
afeiszli committed Jan 16, 2024
1 parent d6bb1a9 commit 9b5383c
Showing 1 changed file with 31 additions and 21 deletions.
52 changes: 31 additions & 21 deletions quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,37 @@ Important Notes

0. Prerequisites
==================
- **Virtual Machine**

- 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 21.04 Installed

- **Domain**

- 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. Cloudflare 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.

Server
-----------------

All components of Netmaker can be run on a single server (Virtual Machine or Bare Metal). Here some recommendations for setting up the server:

- 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.
- 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 21.04 Installed

If you do not have a host for this server, here are some recommendations:

- `DigitalOcean (preferred) <https://marketplace.digitalocean.com/apps/netmaker>`_
- `Linode <https://www.linode.com>`_
- `KeepSec <https://www.keepsec.ca>`_
- `AWS <https://aws.amazon.com>`_
- `Azure <https://azure.microsoft.com>`_
- `GCP <https://cloud.google.com>`_
- We **do not** recommend Oracle Cloud. There are known issues with their network configuration.

Domain
--------

Your server will host several services (netmaker server, UI, etc.) each of which requires a dedicated, public subdomain. Here are some recommendations:

- Use a publicly owned domain (e.x. example.com, mysite.biz)
- Designate a subdomain (e.g. netmaker.example.com) for netmaker's services (e.g. dashboard.netmaker.example.com)
- Make sure you have permission and access to modify DNS records for your domain (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. Cloudflare 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
================
Expand Down

0 comments on commit 9b5383c

Please sign in to comment.