mirror of
https://github.com/gravitl/netmaker.git
synced 2025-10-25 05:27:23 +08:00
requirements for material docs
This commit is contained in:
afeiszli
parent
2e2a516caa
commit
0a79929ac3
10 changed files with 27 additions and 29 deletions
BIN
docs/_build/doctrees/environment.pickle
vendored
BIN
docs/_build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/_build/doctrees/index.doctree
vendored
BIN
docs/_build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/_build/doctrees/server-installation.doctree
vendored
BIN
docs/_build/doctrees/server-installation.doctree
vendored
Binary file not shown.
7
docs/_build/html/_sources/index.rst.txt
vendored
7
docs/_build/html/_sources/index.rst.txt
vendored
|
|
@ -23,10 +23,11 @@ Netmaker is a platform for creating and managing fast, secure, and dynamic virtu
|
|||
|
||||
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.
|
||||
|
||||
:raw-html:`<br />`
|
||||
|
||||
.. raw:: html
|
||||
:file: youtube-1.html
|
||||
.. :raw-html:`<br />`
|
||||
|
||||
.. .. raw:: html
|
||||
.. :file: youtube-1.html
|
||||
|
||||
About
|
||||
------
|
||||
|
|
|
|||
|
|
@ -232,7 +232,7 @@ SERVER_GRPC_HOST:
|
|||
API_PORT:
|
||||
**Default:** 8081
|
||||
|
||||
**Description:** The HTTP API port for Netmaker. Used for API calls / communication from front end. If changed, need to change port of BACKEND_URL for netmaker-ui.
|
||||
**Description:** The HTTP API port for Netmaker. Used for API calls / communication from front end.
|
||||
|
||||
GRPC_PORT:
|
||||
**Default:** 50051
|
||||
|
|
@ -267,7 +267,7 @@ CLIENT_MODE:
|
|||
DNS_MODE:
|
||||
**Default:** "on"
|
||||
|
||||
**Description:** Enables DNS Mode, meaning config files will be generated for CoreDNS. Note, turning "off" does not remove CoreDNS. You still need to remove CoreDNS from compose file.
|
||||
**Description:** Enables DNS Mode, meaning config files will be generated for CoreDNS.
|
||||
|
||||
DISABLE_REMOTE_IP_CHECK:
|
||||
**Default:** "off"
|
||||
|
|
@ -277,22 +277,22 @@ DISABLE_REMOTE_IP_CHECK:
|
|||
MONGO_ADMIN:
|
||||
**Default:** "mongoadmin"
|
||||
|
||||
**Description:** Admin user for MongoDB. Change to match above MongoDB instance
|
||||
**Description:** Admin user for MongoDB.
|
||||
|
||||
MONGO_PASS:
|
||||
**Default:** "mongopass"
|
||||
|
||||
**Description:** Admin password for MongoDB. Change to match above MongoDB instance
|
||||
**Description:** Admin password for MongoDB.
|
||||
|
||||
MONGO_HOST:
|
||||
**Default:** "127.0.0.1"
|
||||
|
||||
**Description:** Address of MongoDB. Change if necessary.
|
||||
**Description:** Address of MongoDB.
|
||||
|
||||
MONGO_PORT:
|
||||
**Default:** "27017"
|
||||
|
||||
**Description:** Port of MongoDB. Change if necessary.
|
||||
**Description:** Port of MongoDB.
|
||||
|
||||
MONGO_OPTS:
|
||||
**Default:** "/?authSource=admin"
|
||||
|
|
|
|||
5
docs/_build/html/index.html
vendored
5
docs/_build/html/index.html
vendored
|
|
@ -717,11 +717,6 @@
|
|||
<h1 id="index--page-root">Welcome to the Netmaker Documentation<a class="headerlink" href="#index--page-root" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Netmaker is a platform for creating and managing fast, secure, and dynamic virtual overlay networks using WireGuard.</p>
|
||||
<p>This documentation covers Netmaker’s <a class="reference internal" href="server-installation.html"><span class="doc">installation</span></a>, <a class="reference internal" href="usage.html"><span class="doc">usage</span></a>, <a class="reference internal" href="support.html"><span class="doc">troubleshooting</span></a>, and customization, as well as reference documents for the <a class="reference internal" href="api.html"><span class="doc">API</span></a>, UI and Agent configuration. All of the <a class="reference external" href="https://github.com/gravitl/netmaker">source code</a> for Netmaker is on GitHub.</p>
|
||||
<p><span class="raw-html"><br/></span></p>
|
||||
<div style="position:relative; width:100%; height:0px; padding-bottom:56.25%;">
|
||||
<iframe src="https://www.youtube.com/embed/PWLPT320Ybo" style="position:absolute; left:0; top:0; width:100%; height:100%">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<h2 id="about">About<a class="headerlink" href="#about" title="Permalink to this headline">¶</a></h2>
|
||||
<p>A quick overview of Netmaker, explaining what it is, how it works, and why you should be using it.</p>
|
||||
|
|
|
|||
12
docs/_build/html/server-installation.html
vendored
12
docs/_build/html/server-installation.html
vendored
|
|
@ -1094,7 +1094,7 @@
|
|||
<p><strong>Description:</strong> Set to make the HTTP and GRPC functions available via different interfaces/networks.</p>
|
||||
</dd>
|
||||
<dt>API_PORT:</dt><dd><p><strong>Default:</strong> 8081</p>
|
||||
<p><strong>Description:</strong> The HTTP API port for Netmaker. Used for API calls / communication from front end. If changed, need to change port of BACKEND_URL for netmaker-ui.</p>
|
||||
<p><strong>Description:</strong> The HTTP API port for Netmaker. Used for API calls / communication from front end.</p>
|
||||
</dd>
|
||||
<dt>GRPC_PORT:</dt><dd><p><strong>Default:</strong> 50051</p>
|
||||
<p><strong>Description:</strong> The GRPC port for Netmaker. Used for communications from nodes.</p>
|
||||
|
|
@ -1115,22 +1115,22 @@
|
|||
<p><strong>Description:</strong> Enables Client Mode, meaning netclient will be deployed on server and will be manageable from UI. Change to “off” to turn off.</p>
|
||||
</dd>
|
||||
<dt>DNS_MODE:</dt><dd><p><strong>Default:</strong> “on”</p>
|
||||
<p><strong>Description:</strong> Enables DNS Mode, meaning config files will be generated for CoreDNS. Note, turning “off” does not remove CoreDNS. You still need to remove CoreDNS from compose file.</p>
|
||||
<p><strong>Description:</strong> Enables DNS Mode, meaning config files will be generated for CoreDNS.</p>
|
||||
</dd>
|
||||
<dt>DISABLE_REMOTE_IP_CHECK:</dt><dd><p><strong>Default:</strong> “off”</p>
|
||||
<p><strong>Description:</strong> If turned “on”, Server will not set Host based on remote IP check. This is already overridden if SERVER_HOST is set. Turned “off” by default.</p>
|
||||
</dd>
|
||||
<dt>MONGO_ADMIN:</dt><dd><p><strong>Default:</strong> “mongoadmin”</p>
|
||||
<p><strong>Description:</strong> Admin user for MongoDB. Change to match above MongoDB instance</p>
|
||||
<p><strong>Description:</strong> Admin user for MongoDB.</p>
|
||||
</dd>
|
||||
<dt>MONGO_PASS:</dt><dd><p><strong>Default:</strong> “mongopass”</p>
|
||||
<p><strong>Description:</strong> Admin password for MongoDB. Change to match above MongoDB instance</p>
|
||||
<p><strong>Description:</strong> Admin password for MongoDB.</p>
|
||||
</dd>
|
||||
<dt>MONGO_HOST:</dt><dd><p><strong>Default:</strong> “127.0.0.1”</p>
|
||||
<p><strong>Description:</strong> Address of MongoDB. Change if necessary.</p>
|
||||
<p><strong>Description:</strong> Address of MongoDB.</p>
|
||||
</dd>
|
||||
<dt>MONGO_PORT:</dt><dd><p><strong>Default:</strong> “27017”</p>
|
||||
<p><strong>Description:</strong> Port of MongoDB. Change if necessary.</p>
|
||||
<p><strong>Description:</strong> Port of MongoDB.</p>
|
||||
</dd>
|
||||
<dt>MONGO_OPTS:</dt><dd><p><strong>Default:</strong> “/?authSource=admin”</p>
|
||||
<p><strong>Description:</strong> Opts to enable admin login for Mongo.</p>
|
||||
|
|
|
|||
|
|
@ -23,10 +23,11 @@ Netmaker is a platform for creating and managing fast, secure, and dynamic virtu
|
|||
|
||||
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.
|
||||
|
||||
:raw-html:`<br />`
|
||||
|
||||
.. raw:: html
|
||||
:file: youtube-1.html
|
||||
.. :raw-html:`<br />`
|
||||
|
||||
.. .. raw:: html
|
||||
.. :file: youtube-1.html
|
||||
|
||||
About
|
||||
------
|
||||
|
|
|
|||
1
docs/requirements.txt
Normal file
1
docs/requirements.txt
Normal file
|
|
@ -0,0 +1 @@
|
|||
sphinx-material
|
||||
|
|
@ -232,7 +232,7 @@ SERVER_GRPC_HOST:
|
|||
API_PORT:
|
||||
**Default:** 8081
|
||||
|
||||
**Description:** The HTTP API port for Netmaker. Used for API calls / communication from front end. If changed, need to change port of BACKEND_URL for netmaker-ui.
|
||||
**Description:** The HTTP API port for Netmaker. Used for API calls / communication from front end.
|
||||
|
||||
GRPC_PORT:
|
||||
**Default:** 50051
|
||||
|
|
@ -267,7 +267,7 @@ CLIENT_MODE:
|
|||
DNS_MODE:
|
||||
**Default:** "on"
|
||||
|
||||
**Description:** Enables DNS Mode, meaning config files will be generated for CoreDNS. Note, turning "off" does not remove CoreDNS. You still need to remove CoreDNS from compose file.
|
||||
**Description:** Enables DNS Mode, meaning config files will be generated for CoreDNS.
|
||||
|
||||
DISABLE_REMOTE_IP_CHECK:
|
||||
**Default:** "off"
|
||||
|
|
@ -277,22 +277,22 @@ DISABLE_REMOTE_IP_CHECK:
|
|||
MONGO_ADMIN:
|
||||
**Default:** "mongoadmin"
|
||||
|
||||
**Description:** Admin user for MongoDB. Change to match above MongoDB instance
|
||||
**Description:** Admin user for MongoDB.
|
||||
|
||||
MONGO_PASS:
|
||||
**Default:** "mongopass"
|
||||
|
||||
**Description:** Admin password for MongoDB. Change to match above MongoDB instance
|
||||
**Description:** Admin password for MongoDB.
|
||||
|
||||
MONGO_HOST:
|
||||
**Default:** "127.0.0.1"
|
||||
|
||||
**Description:** Address of MongoDB. Change if necessary.
|
||||
**Description:** Address of MongoDB.
|
||||
|
||||
MONGO_PORT:
|
||||
**Default:** "27017"
|
||||
|
||||
**Description:** Port of MongoDB. Change if necessary.
|
||||
**Description:** Port of MongoDB.
|
||||
|
||||
MONGO_OPTS:
|
||||
**Default:** "/?authSource=admin"
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue