2021-05-26 05:57:06 +08:00
.. Netmaker documentation master file, created by
sphinx-quickstart on Fri May 14 08:51:40 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree`
.. image :: images/netmaker.png
:width: 100%
:alt: Netmaker WireGuard
:align: center
=======================================
Welcome to the Netmaker Documentation
=======================================
Netmaker is a platform for creating and managing fast, secure, and dynamic virtual overlay networks using WireGuard.
This documentation covers Netmaker's :doc: `installation <./server-installation>` , :doc: `usage <./usage>` , :doc: `troubleshooting <./support>` , and customization, as well as reference documents for the :doc: `API <./api>` , UI and Agent configuration. All of the `source code <https://github.com/gravitl/netmaker> `_ for Netmaker is on GitHub.
2022-01-18 00:28:28 +08:00
**For Kubernetes-specific guidance, please see the** `Netmaker Kubernetes Documentation. <https://k8s.netmaker.org> `_
2021-05-26 05:57:06 +08:00
About
2022-01-14 06:55:54 +08:00
--------
2021-05-26 05:57:06 +08:00
2022-01-16 23:09:19 +08:00
High-level information about what Netmaker is and how it works.
2021-05-26 05:57:06 +08:00
.. toctree ::
:maxdepth: 2
2022-01-14 06:55:54 +08:00
2021-05-26 05:57:06 +08:00
about
architecture
2022-01-16 23:09:19 +08:00
Getting Started
2021-10-07 06:24:38 +08:00
------------------------------------
2022-01-16 23:09:19 +08:00
How to install Netmaker and set up your first network.
2021-10-07 06:24:38 +08:00
.. toctree ::
2022-01-16 23:09:19 +08:00
:maxdepth: 2
2021-10-07 06:24:38 +08:00
install
2021-05-26 05:57:06 +08:00
quick-start
2021-08-10 22:02:15 +08:00
getting-started
2022-01-16 23:09:19 +08:00
Ingress, Egress, and Relays
------------------------------
2021-05-26 05:57:06 +08:00
2022-01-16 23:09:19 +08:00
How to give machines outside of the Netmaker network access to network resources via an Ingress Gateway:
2021-05-26 05:57:06 +08:00
.. toctree ::
:maxdepth: 2
2022-01-16 23:09:19 +08:00
external-clients
2021-05-26 05:57:06 +08:00
2022-01-16 23:09:19 +08:00
How to give machines inside the Netmaker network access to external network resources via an Egress Gateway:
2021-10-29 00:56:05 +08:00
.. toctree ::
:maxdepth: 2
2022-01-16 23:09:19 +08:00
egress-gateway
2021-10-29 00:56:05 +08:00
2022-01-16 23:09:19 +08:00
How to make machines inside the network reachable if they are blocked by NAT/Firewall:
2021-10-29 00:56:05 +08:00
2022-01-16 23:09:19 +08:00
.. toctree ::
:maxdepth: 2
relay-server
2021-05-26 05:57:06 +08:00
2022-01-16 23:09:19 +08:00
Kubernetes Documentation
---------------------------
2021-05-26 05:57:06 +08:00
.. toctree ::
2022-01-16 23:09:19 +08:00
2022-01-18 00:28:28 +08:00
Kubernetes <https://k8s.netmaker.org>
2021-05-26 05:57:06 +08:00
2022-01-18 00:28:28 +08:00
`Netmaker Kubernetes Documentation <https://k8s.netmaker.org> `_
2021-05-26 05:57:06 +08:00
2022-01-16 23:09:19 +08:00
Advanced Server Installation
-------------------------------
A detailed guide to installing the Netmaker server (API, DB, UI, DNS), and configuration options.
2021-05-26 05:57:06 +08:00
.. toctree ::
2022-01-16 23:09:19 +08:00
:maxdepth: 2
2021-05-26 05:57:06 +08:00
2022-01-16 23:09:19 +08:00
server-installation
2021-05-26 05:57:06 +08:00
2022-01-16 23:09:19 +08:00
Advanced Client Installation
--------------------------------
2022-01-14 06:55:54 +08:00
2022-01-16 23:09:19 +08:00
A detailed guide to installing the Netmaker agent (netclient) on devices and configuration options.
2022-01-14 06:55:54 +08:00
.. toctree ::
2022-01-16 23:09:19 +08:00
:maxdepth: 2
2022-01-14 06:55:54 +08:00
2022-01-16 23:09:19 +08:00
client-installation
Oauth Configuration
--------------------
2022-01-14 06:55:54 +08:00
2022-01-16 23:09:19 +08:00
A simple guide to configuring OAuth for Netmaker.
2022-01-14 06:55:54 +08:00
.. toctree ::
2022-01-16 23:09:19 +08:00
:maxdepth: 2
2022-01-14 06:55:54 +08:00
2022-01-16 23:09:19 +08:00
oauth
2022-01-14 06:55:54 +08:00
2022-01-16 23:09:19 +08:00
External Guides
2021-05-26 05:57:06 +08:00
----------------
A handful of guides for use cases including site-to-site, Kubernetes, private DNS, and more.
.. toctree ::
:maxdepth: 2
usage
2022-01-14 06:55:54 +08:00
UI Reference
---------------
A reference document for the Netmaker Server UI, with annotated screenshot detailing each field.
.. toctree ::
:maxdepth: 2
ui-reference
2021-05-26 05:57:06 +08:00
API Reference
---------------
A reference document for the Netmaker Server API, and example API calls for various use cases.
.. toctree ::
:maxdepth: 1
api
2022-01-14 06:55:54 +08:00
Upgrades
----------------
Upgrading the Netmaker server and clients.
.. toctree ::
:maxdepth: 1
upgrades
2021-05-26 05:57:06 +08:00
Troubleshooting
----------------
Help with common Netmaker/netclient issues.
.. toctree ::
:maxdepth: 2
troubleshoot
Support
----------------
Where to go for help, and a FAQ.
.. toctree ::
:maxdepth: 2
support
Code of Conduct
-----------------
A statement on our expectations and pledge to the community.
.. toctree ::
conduct.rst
Licensing
---------------
A link to the Netmaker license.
.. toctree ::
license.rst
