mirror of
https://github.com/netbirdio/netbird.git
synced 2025-06-25 12:12:12 +02:00
Add windows documentation
This commit is contained in:
parent
20248dadb7
commit
c18899d135
47
README.md
47
README.md
@ -66,14 +66,28 @@ After that you may need to add /usr/local/bin in your MAC's PATH environment var
|
|||||||
````shell
|
````shell
|
||||||
export PATH=$PATH:/usr/local/bin
|
export PATH=$PATH:/usr/local/bin
|
||||||
````
|
````
|
||||||
|
|
||||||
|
#### Windows
|
||||||
|
1. Checkout Wiretrustee [releases](https://github.com/wiretrustee/wiretrustee/releases/latest)
|
||||||
|
2. Download the latest Windows release ```wiretrustee_<VERSION>_windows_amd64.tar.gz``` (**Switch VERSION to the latest**):
|
||||||
|
3. Decompress and move to a more fixed path in your system
|
||||||
|
4. Open Powershell
|
||||||
|
5. For Windows systems, we can use the service command to configure Wiretrustee as a service
|
||||||
|
````shell
|
||||||
|
cd C:\path\to\wiretrustee\bin
|
||||||
|
.\wiretrustee.exe service --help
|
||||||
|
.\wiretrustee.exe service install # This will prompt for administrator permissions in order to install a new service
|
||||||
|
````
|
||||||
|
6. After installing you can follow the [Client Configuration](#Client-Configuration) steps.
|
||||||
|
7. To uninstall the service simple run the command above with the uninstall flag:
|
||||||
|
````shell
|
||||||
|
.\wiretrustee.exe service uninstall
|
||||||
|
````
|
||||||
|
|
||||||
### Client Configuration
|
### Client Configuration
|
||||||
1. Initialize Wiretrustee:
|
1. Initialize Wiretrustee:
|
||||||
|
|
||||||
For **MACOS**, you need to create the configuration directory:
|
For **Unix** systems:
|
||||||
````shell
|
|
||||||
sudo mkdir /etc/wiretrustee
|
|
||||||
````
|
|
||||||
Then, for all systems:
|
|
||||||
```shell
|
```shell
|
||||||
sudo wiretrustee init \
|
sudo wiretrustee init \
|
||||||
--stunURLs stun:stun.wiretrustee.com:3468,stun:stun.l.google.com:19302 \
|
--stunURLs stun:stun.wiretrustee.com:3468,stun:stun.l.google.com:19302 \
|
||||||
@ -82,6 +96,16 @@ sudo wiretrustee init \
|
|||||||
--wgLocalAddr 10.30.30.1/24 \
|
--wgLocalAddr 10.30.30.1/24 \
|
||||||
--log-level info
|
--log-level info
|
||||||
```
|
```
|
||||||
|
For **Windows** systems:
|
||||||
|
```shell
|
||||||
|
.\wiretrustee.exe init `
|
||||||
|
--stunURLs stun:stun.wiretrustee.com:3468,stun:stun.l.google.com:19302 `
|
||||||
|
--turnURLs <TURN User>:<TURN password>@turn:stun.wiretrustee.com:3468 `
|
||||||
|
--signalAddr signal.wiretrustee.com:10000 `
|
||||||
|
--wgLocalAddr 10.30.30.1/24 `
|
||||||
|
--log-level info
|
||||||
|
```
|
||||||
|
|
||||||
It is important to mention that the ```wgLocalAddr``` parameter has to be unique across your network.
|
It is important to mention that the ```wgLocalAddr``` parameter has to be unique across your network.
|
||||||
E.g. if you have Peer A with ```wgLocalAddr=10.30.30.1/24``` then another Peer B can have ```wgLocalAddr=10.30.30.2/24```
|
E.g. if you have Peer A with ```wgLocalAddr=10.30.30.1/24``` then another Peer B can have ```wgLocalAddr=10.30.30.2/24```
|
||||||
|
|
||||||
@ -89,11 +113,16 @@ If for some reason, you already have a generated Wireguard key, you can specify
|
|||||||
If not specified, then a new one will be generated, and its corresponding public key will be output to the log.
|
If not specified, then a new one will be generated, and its corresponding public key will be output to the log.
|
||||||
A new config will be generated and stored under ```/etc/wiretrustee/config.json```
|
A new config will be generated and stored under ```/etc/wiretrustee/config.json```
|
||||||
|
|
||||||
2. Add a peer to connect to.
|
2. Add a peer to connect to.
|
||||||
|
|
||||||
|
For **Unix** systems:
|
||||||
```shell
|
```shell
|
||||||
sudo wiretrustee add-peer --allowedIPs 10.30.30.2/32 --key '<REMOTE PEER WIREUARD PUBLIC KEY>'
|
sudo wiretrustee add-peer --allowedIPs 10.30.30.2/32 --key '<REMOTE PEER WIREUARD PUBLIC KEY>'
|
||||||
```
|
```
|
||||||
|
For **Windows** systems:
|
||||||
|
```shell
|
||||||
|
.\wiretrustee.exe add-peer --allowedIPs 10.30.30.2/32 --key '<REMOTE PEER WIREUARD PUBLIC KEY>'
|
||||||
|
```
|
||||||
3. Restart Wiretrustee to reload changes
|
3. Restart Wiretrustee to reload changes
|
||||||
For **MACOS** you will just start the service:
|
For **MACOS** you will just start the service:
|
||||||
````shell
|
````shell
|
||||||
@ -106,6 +135,10 @@ For **Linux** systems:
|
|||||||
sudo systemctl restart wiretrustee.service
|
sudo systemctl restart wiretrustee.service
|
||||||
sudo systemctl status wiretrustee.service
|
sudo systemctl status wiretrustee.service
|
||||||
```
|
```
|
||||||
|
For **Windows** systems:
|
||||||
|
```shell
|
||||||
|
.\wiretrustee.exe service start
|
||||||
|
```
|
||||||
### Running the Signal service
|
### Running the Signal service
|
||||||
After installing the application, you can run the signal using the command below:
|
After installing the application, you can run the signal using the command below:
|
||||||
````shell
|
````shell
|
||||||
|
Loading…
x
Reference in New Issue
Block a user