mirror of
https://github.com/gravitl/netmaker.git
synced 2024-09-21 15:56:07 +08:00
200 lines
3.7 KiB
ReStructuredText
200 lines
3.7 KiB
ReStructuredText
.. 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` directive.
|
|
|
|
|
|
.. image:: images/netmaker.png
|
|
:width: 100%
|
|
:alt: Netmaker WireGuard
|
|
:align: center
|
|
|
|
.. role:: raw-html(raw)
|
|
:format: html
|
|
|
|
:raw-html:`<br />`
|
|
|
|
=======================================
|
|
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.
|
|
|
|
**For Kubernetes-specific guidance, please see the** `Netmaker Kubernetes Documentation. <https://k8s.netmaker.org>`_
|
|
|
|
About
|
|
--------
|
|
|
|
High-level information about what Netmaker is and how it works.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
about
|
|
|
|
architecture
|
|
|
|
Getting Started
|
|
------------------------------------
|
|
|
|
How to install Netmaker and set up your first network.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
install
|
|
|
|
quick-start
|
|
|
|
getting-started
|
|
|
|
Ingress, Egress, and Relays
|
|
------------------------------
|
|
|
|
How to give machines outside of the Netmaker network access to network resources via an Ingress Gateway:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
external-clients
|
|
|
|
How to give machines inside the Netmaker network access to external network resources via an Egress Gateway:
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
egress-gateway
|
|
|
|
How to make machines inside the network reachable if they are blocked by NAT/Firewall:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
relay-server
|
|
|
|
Kubernetes Documentation
|
|
---------------------------
|
|
|
|
.. toctree::
|
|
|
|
Kubernetes <https://k8s.netmaker.org>
|
|
|
|
`Netmaker Kubernetes Documentation <https://k8s.netmaker.org>`_
|
|
|
|
|
|
Advanced Server Installation
|
|
-------------------------------
|
|
|
|
A detailed guide to installing the Netmaker server (API, DB, UI, DNS), and configuration options.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
server-installation
|
|
|
|
Advanced Client Installation
|
|
--------------------------------
|
|
|
|
A detailed guide to installing the Netmaker agent (netclient) on devices and configuration options.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
client-installation
|
|
|
|
|
|
Oauth Configuration
|
|
--------------------
|
|
|
|
A simple guide to configuring OAuth for Netmaker.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
oauth
|
|
|
|
|
|
External Guides
|
|
----------------
|
|
|
|
A handful of guides for use cases including site-to-site, Kubernetes, private DNS, and more.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
usage
|
|
|
|
UI Reference
|
|
---------------
|
|
|
|
A reference document for the Netmaker Server UI, with annotated screenshot detailing each field.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
ui-reference
|
|
|
|
API Reference
|
|
---------------
|
|
|
|
A reference document for the Netmaker Server API, and example API calls for various use cases.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
api
|
|
|
|
Upgrades
|
|
----------------
|
|
|
|
Upgrading the Netmaker server and clients.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
upgrades
|
|
|
|
|
|
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
|