Skip to content

Commit

Permalink
Merge pull request #1344 from nerdalert/docs-windows
Browse files Browse the repository at this point in the history
Added windows instructions in the docs  quick start
  • Loading branch information
mergify[bot] authored Aug 25, 2023
2 parents 8b2b0db + 0611b18 commit 4bed558
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,25 @@ Query the status of `nexd` and follow the instructions to register your device.
sudo nexctl nexd status
```

### Windows

There are various ways for Windows to start processes and services with Powershell and an eventual nexodus agent GUI, but for testing Nexodus on a Windows device, the following is a simple method.

- For Windows, you will need to install Wireguard from the official [Windows Wireguard](https://www.wireguard.com/install/) installer.
- Download the [Windows x86-64](https://nexodus-io.s3.amazonaws.com/qa/nexodus-windows-amd64.zip) zip file containing the `nexd.exe` and `nexctl.exe` executables. For simplicity, move those two files to `C:\` (or into a directory in your $PATH).
- In the start menu, type `cmd` and right-click on `Command Prompt` and `Run as Administrator`. Then, run the following in the command line and follow the URL to authenticate.

```terminal
C:\Users\Administrator> cd C:\
C:\> nexd.exe
Your device must be registered with Nexodus.
Your one-time code is: LYNW-HKGO
Please open the following URL in your browser to sign in:
https://auth.try.nexodus.io/realms/nexodus/device?user_code=LYNW-HKGO
```

- You will now have an IP address on an interface named `wg0` and be peered with other Nexodus devices in the organization, which can be viewed by running `nexctl nexd peers list` in another window.

### Docker or Podman

For testing purposes, you can run the Nexodus Agent in a container. The following command will start a container and launch a shell inside it.
Expand Down
10 changes: 10 additions & 0 deletions docs/user-guide/network-routers.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ The situations where this can be useful are wide-ranging. They can span from con
nexd router --child-prefix 192.168.100.0/24 --network-router
```

- If you are running nexd in a container, additional capabilities need to be added to the container at runtime. Here is an example on how to start a container with IPv4/IPv6 forwarding capabilities enabled.

```terminal
docker run --rm -it --cap-add SYS_MODULE --cap-add NET_ADMIN --cap-add NET_RAW \
--sysctl net.ipv4.ip_forward=1 \
--sysctl net.ipv6.conf.all.disable_ipv6=0 \
--sysctl net.ipv6.conf.all.forwarding=1 \
quay.io/nexodus/nexd
```

![no-alt-text](../images/network-router-simple-example-1.png)

> **Note**
Expand Down

0 comments on commit 4bed558

Please sign in to comment.