extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2025-02-28 08:00:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: correct installation steps

Browse Source
This commit is contained in:
braginini 2021-10-03 18:55:47 +02:00
parent e17f662683
commit 1685817171
1 changed files with 76 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
README.md
View File

@ -51,108 +51,120 @@ https://github.com/wiretrustee/wiretrustee/blob/main/docs/README.md
### Client Installation ### Client Installation
#### Linux #### Linux
1. Checkout Wiretrustee [releases](https://github.com/wiretrustee/wiretrustee/releases)
2. Download the latest release (**Switch VERSION to the latest**):
**Debian packages** **APT/Debian**
```shell 1. Add the repository:
wget https://github.com/wiretrustee/wiretrustee/releases/download/v<VERSION>/wiretrustee_<VERSION>_linux_amd64.deb ```shell
``` sudo apt-get update
3. Install the package sudo apt-get install ca-certificates curl gnupg -y
```shell curl -L https://pkgs.wiretrustee.com/debian/public.key | sudo apt-key add -
sudo dpkg -i wiretrustee_<VERSION>_linux_amd64.deb echo 'deb https://pkgs.wiretrustee.com/debian stable main' | sudo tee /etc/apt/sources.list.d/wiretrustee.list
``` ```
**Fedora/Centos packages** 2. Install the package
```shell ```shell
wget https://github.com/wiretrustee/wiretrustee/releases/download/v<VERSION>/wiretrustee_<VERSION>_linux_amd64.rpm sudo apt-get update
``` sudo apt-get install wiretrustee
3. Install the package ```
```shell **RPM/Red hat**
sudo rpm -i wiretrustee_<VERSION>_linux_amd64.rpm 1. Add the repository:
``` ```shell
cat <<EOF | sudo tee /etc/yum.repos.d/wiretrustee.repo
[Wiretrustee]
name=Wiretrustee
baseurl=https://pkgs.wiretrustee.com/yum/
enabled=1
gpgcheck=0
gpgkey=https://pkgs.wiretrustee.com/yum/repodata/repomd.xml.key
repo_gpgcheck=1
EOF
```
2. Install the package
```shell
sudo yum install wiretrustee
```
#### MACOS #### MACOS
**Brew install** **Brew install**
1. Download and install Brew at https://brew.sh/ 1. Download and install Brew at https://brew.sh/
2. Install the client 2. Install the client
```shell ```shell
brew install wiretrustee/client/wiretrustee brew install wiretrustee/client/wiretrustee
``` ```
**Installation from binary** **Installation from binary**
1. Checkout Wiretrustee [releases](https://github.com/wiretrustee/wiretrustee/releases/latest) 1. Checkout Wiretrustee [releases](https://github.com/wiretrustee/wiretrustee/releases/latest)
2. Download the latest release (**Switch VERSION to the latest**): 2. Download the latest release (**Switch VERSION to the latest**):
```shell ```shell
curl -o ./wiretrustee_<VERSION>_darwin_amd64.tar.gz https://github.com/wiretrustee/wiretrustee/releases/download/v<VERSION>/wiretrustee_<VERSION>_darwin_amd64.tar.gz curl -o ./wiretrustee_<VERSION>_darwin_amd64.tar.gz https://github.com/wiretrustee/wiretrustee/releases/download/v<VERSION>/wiretrustee_<VERSION>_darwin_amd64.tar.gz
``` ```
3. Decompress 3. Decompress
```shell ```shell
tar xcf ./wiretrustee_<VERSION>_darwin_amd64.tar.gz tar xcf ./wiretrustee_<VERSION>_darwin_amd64.tar.gz
sudo mv wiretrusee /usr/local/bin/wiretrustee sudo mv wiretrusee /usr/local/bin/wiretrustee
chmod +x /usr/local/bin/wiretrustee chmod +x /usr/local/bin/wiretrustee
``` ```
After that you may need to add /usr/local/bin in your MAC's PATH environment variable: After that you may need to add /usr/local/bin in your MAC's PATH environment variable:
````shell ````shell
export PATH=$PATH:/usr/local/bin export PATH=$PATH:/usr/local/bin
```` ````
#### Windows #### Windows
1. Checkout Wiretrustee [releases](https://github.com/wiretrustee/wiretrustee/releases/latest) 1. Checkout Wiretrustee [releases](https://github.com/wiretrustee/wiretrustee/releases/latest)
2. Download the latest Windows release installer ```wiretrustee_installer_<VERSION>_windows_amd64.exe``` (**Switch VERSION to the latest**): 2. Download the latest Windows release installer ```wiretrustee_installer_<VERSION>_windows_amd64.exe``` (**Switch VERSION to the latest**):
3. Proceed with installation steps 3. Proceed with installation steps
4. This will install the client in the C:\\Program Files\\Wiretrustee and add the client service 4. This will install the client in the C:\\Program Files\\Wiretrustee and add the client service
5. After installing you can follow the [Client Configuration](#Client-Configuration) steps. 5. After installing, you can follow the [Client Configuration](#Client-Configuration) steps.
> To uninstall the client and service, you can use Add/Remove programs > To uninstall the client and service, you can use Add/Remove programs
### Client Configuration ### Client Configuration
1. Login to the Management Service. You need to have a `setup key` in hand (see ). 1. Login to the Management Service. You need to have a `setup key` in hand (see ).
For **Unix** systems: For **Unix** systems:
```shell ```shell
sudo wiretrustee login --setup-key <SETUP KEY> sudo wiretrustee login --setup-key <SETUP KEY>
``` ```
For **Windows** systems: For **Windows** systems:
```shell ```shell
.\wiretrustee.exe login --setup-key <SETUP KEY> .\wiretrustee.exe login --setup-key <SETUP KEY>
``` ```
Alternatively, if you are hosting your own Management Service provide `--management-url` property pointing to your Management Service: Alternatively, if you are hosting your own Management Service provide `--management-url` property pointing to your Management Service:
```shell ```shell
sudo wiretrustee login --setup-key <SETUP KEY> --management-url https://localhost:33073 sudo wiretrustee login --setup-key <SETUP KEY> --management-url https://localhost:33073
``` ```
You could also omit `--setup-key` property. In this case the tool will prompt it the key. You could also omit `--setup-key` property. In this case the tool will prompt it the key.
2. Start Wiretrustee: 2. Start Wiretrustee:
For **MACOS** you will just start the service: For **MACOS** you will just start the service:
````shell ````shell
sudo wiretrustee up sudo wiretrustee up
# or # or
sudo wiretrustee up & # to run it in background sudo wiretrustee up & # to run it in background
```` ````
For **Linux** systems: For **Linux** systems:
```shell ```shell
sudo systemctl restart wiretrustee.service sudo systemctl restart wiretrustee.service
sudo systemctl status wiretrustee.service sudo systemctl status wiretrustee.service
``` ```
For **Windows** systems: For **Windows** systems:
```shell ```shell
.\wiretrustee.exe service start .\wiretrustee.exe service start
``` ```
> You may need to run Powershell as Administrator > You may need to run Powershell as Administrator
3. Check your IP: 3. Check your IP:
For **MACOS** you will just start the service: For **MACOS** you will just start the service:
````shell ````shell
sudo ipconfig getifaddr utun100 sudo ipconfig getifaddr utun100
```` ````
For **Linux** systems: For **Linux** systems:
```shell ```shell
ip addr show wt0 ip addr show wt0
``` ```
For **Windows** systems: For **Windows** systems:
```shell ```shell
netsh interface ip show config name="wt0" netsh interface ip show config name="wt0"
``` ```
4. Repeat on other machines. 4. Repeat on other machines.