Merge pull request #300 from gravitl/develop

Develop

conf.py

@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Netmaker'
-copyright = '2023, Netmaker Inc.'
+copyright = '2024, Netmaker Inc.'
 author = 'Netmaker'
 
 # The full version, including alpha/beta/rc tags
@@ -57,8 +57,8 @@
     "repo_name": "Netmaker",
     'nosidebar': True,
     "repo_type": "github",
-    'color_primary': 'indigo',
-    'color_accent': 'light-blue',
+    'color_primary': 'blue',
+    'color_accent': 'teal',
     'logo_icon': '&#xe869',
     'globaltoc_depth': 2,
     'globaltoc_collapse': True,

features.rst

@@ -2,50 +2,34 @@
 Features
 =========
 
+.. toctree::
+   :maxdepth: 1
+
+   user-management
+   egress-gateway
+   external-clients
+   acls
+   pro/index
+
+**User Management**
 
-Egress Gateway
-===============
+:ref:`user-manage`
+
+**Egress Gateway**
 
 Allows clients (nodes and ext clients) to reach external networks.
 
 :ref:`egress`
 
-
-Remote Access Gateways & Clients
-=================================
+**Remote Access Gateways & Clients**
 
 A remote access gateway enables "external" clients to connect to the network. External clients refer to clients that are not part of the mesh network, but need to connect to it. This could be a laptop, mobile device, or even a server that is not part of the network.
 
 :ref:`remote-access`
 
-
-
-Access Control Lists
-======================
+**Access Control Lists**
 
 ACLs control communications between nodes on a network
 
 :ref:`acls`
 
-
-Netmaker Professional
-======================
-
-Netmaker Professional is our advanced Netmaker offering for business use cases. It offers all the features of community edition plus:
-
-- **Metrics:** Nodes collect networking metrics such as latency, transfer, and connectivity status. These are displayed in the Netmaker UI, and also exported to Grafana via Prometheus.  
-
-- **Users:** On community you can only create admin users, where as on PRO it gives ability to create non-admin users which you can pair with remote-access gateway to segment users on different networks.
-
-- **Remote Access Client:** Netmaker Professional comes with a remote access client that allows you to connect to your network from anywhere. This is a great way to connect to your network from a laptop or mobile device (soon).
-
-- **FailOvers:** FailOvers are made to help two peers communicate where they cannot talk directly due to their firewall restrictions, in which case their connection falls back through a failover node set by the user in the network.
-
-- **Relays:** All traffic routing to and from in a network for a relayed machine will go through the relay machine.
-
-- **Internet Gateways:** These work similar to traditional VPNs, and can work with netclients (hosts in the mesh network) as well as with remote devices connected to the network via client configs.
-
-.. toctree::
-   :maxdepth: 1
-
-   pro/index

how-to-guides.rst

@@ -2,72 +2,40 @@
 How-to-Guides
 ==============
 
+.. toctree::
+   :maxdepth: 1
 
-Egress Gateway
-===============
+   integrating-non-native-devices
+   usage
+
+**Egress Gateway**
 
 
 Netmaker allows your clients to reach external networks via an Egress Gateway. The Egress Gateway is a netclient which has been deployed to a server or router with access to a given subnet.
 
 In the Netmaker UI, that node is set as an "egress gateway." Range(s) are specified which this node has access to. Once created, all clients (and all new ext clients) in the network will be able to reach those ranges via the gateway.
 
-.. toctree::
-   :maxdepth: 2
-
-   egress-gateway
+:ref:`egress`
 
-Remote Access Gateway/External Clients
-======================================
+**Remote Access Gateway/External Clients**
 
 Netmaker allows for "external clients" to reach into a network and access services via an Remote Access Gateway. So what is an "external client"? An external client is any machine which cannot or should not be meshed. This can include:
         - Phones
         - Laptops
         - Desktops
 
-.. toctree::
-   :maxdepth: 2
+:ref:`remote-access`
 
-   external-clients
+**Access Control Lists**
 
-Access Control Lists
-======================
 By default, Netmaker creates a "full mesh," meaning every node in your network can talk to every other node. You don't always want this to be the case. Sometimes, only some connections should be valid. That's why Netmaker has ACLs. By using Netmaker's ACL feature, you can enable/disable any peer-to-peer connection in your network to remove its ability to communicate.
 
-.. toctree::
-   :maxdepth: 2
-
-   acls
+:ref:`acls`
 
-Netmaker Professional
-======================
+**Integrating Non-native Devices**
 
-Netmaker Professional is our advanced Netmaker offering for business use cases. It offers all the features of community edition plus:
-
-- **Metrics:** Nodes collect networking metrics such as latency, transfer, and connectivity status. These are displayed in the Netmaker UI, and also exported to Grafana via Prometheus.  
-
-- **Users:** Community netmaker has rudimentary users, but Professional gives you the ability to create access levels to control network access, and even create groups to organize users. This allows users to log into the dashboard who can only manage ext clients for themselves, or nodes.
+:ref:`integrating-non-native-devices`
 
-- **Remote Access Client:** Netmaker Professional comes with a remote access client that allows you to connect to your network from anywhere. This is a great way to connect to your network from a laptop or mobile device (soon).
+**External Guides**
 
-- **Rely:** Netmaker Professional enables a node to be designated as a relay and to identify which node(s) it should relay.  All traffic to/from relayed node(s) will transverse via the relay. 
-
-.. toctree::
-   :maxdepth: 1
-
-   pro/index
-
-Integrating Non-native Devices
-===============================
-
-.. toctree::
-   :maxdepth: 1
-
-   integrating-non-native-devices
-
-External Guides
-================
-
-.. toctree::
-   :maxdepth: 2
-
-   usage
+:ref:`usage`

index.rst

@@ -23,11 +23,12 @@ This documentation covers Netmaker's :doc:`installation <./server-installation>`
 
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 1
 
    about
    getting-started
    features
+   pro/index
    upgrades
    how-to-guides
    references

netclient.rst

@@ -1,3 +1,5 @@
+.. _netclient:
+
 ==========
 Netclient 
 ==========

oauth.rst

@@ -1,9 +1,8 @@
-====================
 Integrating OAuth
 ====================
 
 Introduction
-==============
+-------------
 
 As of v0.14.5, Netmaker offers integration with the following OAuth providers: 
 
@@ -15,7 +14,7 @@ As of v0.14.5, Netmaker offers integration with the following OAuth providers:
 By integrating with an OAuth provider, your Netmaker users can log in via the provider, rather than the default simple auth.
 
 Configuring your provider
-===========================
+--------------------------
 
 In order to use OAuth, configure your OAuth provider (GitHub, Google, Azure AD).
 
@@ -35,7 +34,7 @@ Instructions for Microsoft Azure AD: https://oauth2-proxy.github.io/oauth2-proxy
 Instructions for OIDC: https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider/#openid-connect-provider
 
 Configuring Netmaker
-======================
+---------------------
 
 After you have configured your OAuth provider, take note of the CLIENT_ID and CLIENT_SECRET. If you are using Azure for oauth, you may also want to note down the Azure tenant ID you wish to use.
 
@@ -87,6 +86,8 @@ To create a new user, click the "Add a User" button on the Users page. Fill in t
    :alt: Edit User 2
    :align: center
 
+.. include_after_this_label
+
 Oauth Users
 -----------
 

pro/index.rst

@@ -3,77 +3,39 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-
-.. image:: ../images/netmaker.png
-   :width: 100%
-   :alt: Netmaker WireGuard
-   :align: center
-
-Setup
---------
-
-How to set up Netmaker Professional
+=====================
+Netmaker Professional
+=====================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    pro-setup
-
-Users
----------------
-
-.. toctree::
-   :maxdepth: 2
-
    pro-users
-
-Relays
----------------
-
-.. toctree::
-   :maxdepth: 2
-
    pro-relay-server
-
-Metrics
-------------------------------------
-
-How to view network metrics in Netmaker Professional
-
-
-.. toctree::
-   :maxdepth: 2
-
    pro-metrics
-
-Branding
-------------
-
-.. toctree::
-   :maxdepth: 2
-
    pro-branding
+   rac
+   pro-failovers
+   internet-gateways
 
-Remote Access Client
------------------------
 
-.. toctree::
-   :maxdepth: 2
+.. image:: ../images/netmaker.png
+   :width: 100%
+   :alt: Netmaker WireGuard
+   :align: center
 
-   rac
+Netmaker Professional is our advanced Netmaker offering for business use cases. It offers all the features of community edition plus:
 
-FailOvers
------------------------
+- **Metrics:** Nodes collect networking metrics such as latency, transfer, and connectivity status. These are displayed in the Netmaker UI, and also exported to Grafana via Prometheus.
 
-.. toctree::
-   :maxdepth: 2
+- **Users:** On community you can only create admin users, where as on PRO it gives ability to create non-admin users which you can pair with remote-access gateway to segment users on different networks.
 
-   pro-failovers
+- **Remote Access Client:** Netmaker Professional comes with a remote access client that allows you to connect to your network from anywhere. This is a great way to connect to your network from a laptop or mobile device (soon).
 
-Internet Gateways
------------------------
+- **FailOvers:** FailOvers are made to help two peers communicate where they cannot talk directly due to their firewall restrictions, in which case their connection falls back through a failover node set by the user in the network.
 
-.. toctree::
-   :maxdepth: 2
+- **Relays:** All traffic routing to and from in a network for a relayed machine will go through the relay machine.
+
+- **Internet Gateways:** These work similar to traditional VPNs, and can work with netclients (hosts in the mesh network) as well as with remote devices connected to the network via client configs.
 
-   internet-gateways

pro/internet-gateways.rst

@@ -22,8 +22,7 @@ This behaviour also happens with remote access gateways and their connected clie
 Usage
 ======
 
-Create an internet gateway
---------------------------
+**Create an internet gateway**
 
 .. image:: images/inet-gw-create.png
    :alt: internet gateway creation
@@ -41,8 +40,7 @@ Create an internet gateway
 **NOTE:** A host already connected to an internet gateway cannot be a gateway itself. ie: internet gateway chaining is not supported currently.
 
 
-Update an internet gateway
---------------------------
+**Update an internet gateway**
 
 .. image:: images/inet-gw-update.png
    :alt: internet gateway update
@@ -54,8 +52,7 @@ Update an internet gateway
 3. Update the gateway and save changes
 
 
-Delete an internet gateway
---------------------------
+**Delete an internet gateway**
 
 .. image:: images/inet-gw-delete.png
    :alt: internet gateway deletion

pro/pro-setup.rst

@@ -1,6 +1,6 @@
-=================================
-Netmaker Professional
-=================================
+===========================
+Netmaker Professional Setup
+===========================
 
 This guide covers how to get setup with Netmaker Professional. For pricing,visit `our pricing page <https://www.netmaker.io/pricing>`_
 
@@ -100,4 +100,4 @@ In Netmaker.env, change the following:
 .. code-block::
 
     METRICS_EXPORTER=on
-    PROMETHEUS=on
+    PROMETHEUS=on