diff --git a/docs/_build/doctrees/client-installation.doctree b/docs/_build/doctrees/client-installation.doctree index 99fcca5f..f62d959a 100644 Binary files a/docs/_build/doctrees/client-installation.doctree and b/docs/_build/doctrees/client-installation.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 65e7c307..957ee4c3 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/html/_sources/client-installation.rst.txt b/docs/_build/html/_sources/client-installation.rst.txt index 155cc5bc..7ea096e0 100644 --- a/docs/_build/html/_sources/client-installation.rst.txt +++ b/docs/_build/html/_sources/client-installation.rst.txt @@ -52,6 +52,8 @@ A user may choose to manually set a private DNS nameserver of : Prerequisites ============= +To obtain the netclient, go to the GitHub releases: https://github.com/gravitl/netmaker/releases + **For netclient cli:** Linux/Unix with WireGuard installed (wg command available) **For netclient daemon:** Systemd Linux + WireGuard @@ -61,29 +63,48 @@ Prerequisites Configuration =============== -Variable Reference +The CLI has information about all commands and variables. This section shows the "help" output for these commands as well as some additional reference. + +CLI Reference -------------------- +``sudo netclient --help`` + +.. literalinclude:: ./examplecode/netclient-help.txt + :language: YAML + + +``sudo netclient join --help`` + +.. literalinclude:: ./examplecode/netclient-join.txt + :language: YAML + Config File Reference ------------------------ -CLI Reference ------------------------- +There is a config file for each node under /etc/netconfig-. You can change these values and then set "postchanges" to "true", or go to the CLI and run ``netclient push -n `` + + +.. literalinclude:: ./examplecode/netconfig-example.yml + :language: YAML + Installation ====================== -Token -------- -Access Key ------------- +To install netmaker, you need a server token for a particular network, unless you're joining a network that allows manual signup, in which case you can join without a token, but the server will quarantine the machine until the admin approves it. -Manual ---------- +An admin creates a token in the ACCESS KEYS section of the UI. Upon creating a token, it generates 3 values: + +**Access Key:** The secret key to authenticate as a node in the network + +**Access Token:** The secret key plus information about how to access the server (addresses, ports), all decoded by the netclient to register with the server + +**Install Command:** A short script that will obtain the netclient binary, register with the server, and join the network, all in one + +For first time installations, you can run the Install Command. For additional networks, simply run ``netclient join -t ``. The raw access key will not be needed unless there are special circumstances, mostly troubleshooting incorrect information in the token (you can instead manually specify the server location). -Config File ------------- Managing Netclient ===================== diff --git a/docs/_build/html/client-installation.html b/docs/_build/html/client-installation.html index f2b42164..4ce3805c 100644 --- a/docs/_build/html/client-installation.html +++ b/docs/_build/html/client-installation.html @@ -425,25 +425,13 @@
  • Configuration
    • -
  • Installation +
  • Installation
  • Managing Netclient