Skip to content

Commit

Permalink
Merge branch 'develop' into NET-1249-docs-improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
uGiFarukh authored Jul 18, 2024
2 parents 3a58ebb + 43d4a30 commit 6ad8edc
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 53 deletions.
39 changes: 0 additions & 39 deletions advanced-client-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,35 +75,6 @@ Event id 0 in Windows Event logs
---------------------------------
netclient service is delegated to Winsw on Windows. An issue is reported that the stop/start/restart events in Event logs show event id as 0 always. It does not impact any netclient functions.

Notes on OpenWRT
===========================

Deploying on OpenWRT depends a lot on the version of OpenWRT and the hardware being used.

1. Ensure you download the appropriate binary for your architecture. replace ${VERSION} with the version you want to download

a. https://github.com/gravitl/netclient/releases/download/${VERSION}/netclient-linux-amd64
b. https://github.com/gravitl/netclient/releases/download/v0.20.5/netclient-linux-arm64
c. https://github.com/gravitl/netclient/releases/download/v0.20.5/netclient-linux-armv5
d. https://github.com/gravitl/netclient/releases/download/v0.20.5/netclient-linux-armv6
e. https://github.com/gravitl/netclient/releases/download/v0.20.5/netclient-linux-armv7
f. https://github.com/gravitl/netclient/releases/download/v0.20.5/netclient-linux-mips-hardfloat
g. https://github.com/gravitl/netclient/releases/download/v0.20.5/netclient-linux-mips-softfloat
h. https://github.com/gravitl/netclient/releases/download/v0.20.5/netclient-linux-mipsle-hardfloat
i. https://github.com/gravitl/netclient/releases/download/v0.20.5/netclient-linux-mipsle-softfloat

2. run netclient install (note: all netclient commands must be run as root) will install the netclient binary to /usr/bin/netclient and service file to /etc/init.d/netclient

3. to start/stop the netclient daemon run

.. code-block::
/sbin/rc-service netclient start/stop
4. run other netclient commands (join, list, connect, disconnect, pull etc ) as required



Modes and System Compatibility
==================================

Expand Down Expand Up @@ -222,16 +193,6 @@ If the daemon is not running correctly, try restarting the daemon, or pulling ch
``sudo netclient pull``


Making Updates
----------------

``vim /etc/netclient/config/netconfig-<network>``

Change any of the variables in this file, and changes will be pushed to the server and processed locally on the next checkin.

For instance, change the private address, endpoint, or name. See above example config file for details


Adding/Removing Networks
---------------------------

Expand Down
15 changes: 4 additions & 11 deletions netclient.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,6 @@ Arch Distros (arch/manjaro/endeavouros)
yay -S netclient
OpenWRT Distros (mips/mipsle)
------------------------------------------------

.. code-block::
refer to Advanced Client Installation :ref:`advanced-client-install:Notes on OpenWRT`
OpenSUSE (tumbleweed/leap)
---------------------------------------------------------------------
Expand All @@ -99,7 +93,7 @@ Windows
Bundled Installer
-----------------

Download Link: https://fileserver.netmaker.org/latest/netclientbundle.exe
Download Link: https://fileserver.netmaker.org/releases/download/latest/netclientbundle.exe

Mac
============
Expand All @@ -113,14 +107,13 @@ Brew Install
(optional) brew audit netclient
brew install netclient
GUI Installer (for v0.22.0 and below)
Installer
-------------------------------------

Download Link for Apple silicon: https://fileserver.netmaker.org/releases/download/v0.22.0/Netclient-M1.pkg
Download Link for Apple silicon: https://fileserver.netmaker.org/releases/download/latest/Netclient-M1.pkg

Download Link for Apple Intel: https://fileserver.netmaker.org/releases/download/v0.22.0/Netclient-Intel.pkg
Download Link for Apple Intel: https://fileserver.netmaker.org/releases/download/latest/Netclient-Intel.pkg

Replace version number in URL with the version you want to install.


Docker
Expand Down
2 changes: 1 addition & 1 deletion pro/rac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can download the M1 or Intel Mac installer from our fileserver link (https:/
**For Windows:**

You can download the `remoteclientbundle.exe` bundle (recommended as this install wireguard and other dependencies) or `remote-access-client_86.msi` installer (MSI doesnt install any dependencies) and run it to install on your windows machine. You can then open the GUI to start using RAC!
Download link: https://fileserver.netmaker.io/latest/remoteclientbundle.exe
Download link: https://fileserver.netmaker.io/releases/download/latest/remoteclientbundle.exe


-----------------------------
Expand Down
5 changes: 3 additions & 2 deletions server-installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ SERVER_HOST
**Description:** The public IP of the server where the machine is running.

MASTER_KEY
**Default:** "secretkey"
**Default:** "secretkey"

**Description:** The admin master key for accessing the API. Change this in any production installation.

MQ_USERNAME
**Default** ""

Expand Down Expand Up @@ -160,6 +160,7 @@ VERBOSITY

REST_BACKEND


**Default** on

**Description** Enables the REST backend (API running on API_PORT at SERVER_HTTP_HOST).
Expand Down

0 comments on commit 6ad8edc

Please sign in to comment.