From ec3920259034f52aeb973ee6f36bb4c842cb4f04 Mon Sep 17 00:00:00 2001 From: Misha Bragin Date: Sun, 29 May 2022 22:39:33 +0200 Subject: [PATCH] Referer README installation steps to docs website (#344) --- README.md | 183 +++--------------------------------------------------- 1 file changed, 9 insertions(+), 174 deletions(-) diff --git a/README.md b/README.md index ada63871b..7a5e4726e 100644 --- a/README.md +++ b/README.md @@ -78,9 +78,16 @@ Netbird creates an overlay peer-to-peer network connecting machines automaticall **Note**: The `main` branch may be in an *unstable or even broken state* during development. For stable versions, see [releases](https://github.com/netbirdio/netbird/releases). -Hosted version: [https://app.netbird.io/](https://app.netbird.io/) +### Start using NetBird +See our documentation for [Quickstart Guide](https://netbird.io/docs/getting-started/quickstart). -[Web UI repository](https://github.com/netbirdio/dashboard) +If you are looking to self-host NetBird, check our [Self-Hosting Guide](https://netbird.io/docs/getting-started/self-hosting). + +Step-by-step [Installation Guide](https://netbird.io/docs/getting-started/installation) for different platforms. + +Hosted version: [https://app.netbird.io/](https://app.netbird.io/). + +[Web UI repository](https://github.com/netbirdio/dashboard). ### A bit on Netbird internals @@ -107,178 +114,6 @@ See a complete [architecture overview](https://netbird.io/docs/overview/architec ### Product Roadmap - [Public Roadmap](https://github.com/netbirdio/netbird/projects/2) -### Client Installation -#### Linux - -**APT/Debian** -1. Add the repository: - ```shell - sudo apt-get update - sudo apt-get install ca-certificates curl gnupg -y - curl -L https://pkgs.wiretrustee.com/debian/public.key | sudo apt-key add - - echo 'deb https://pkgs.wiretrustee.com/debian stable main' | sudo tee /etc/apt/sources.list.d/wiretrustee.list - ``` -2. Update APT's cache - ```shell - sudo apt-get update - ``` -3. Install the package - ```shell - # for CLI only - sudo apt-get install netbird - # for GUI package - sudo apt-get install netbird-ui - ``` -**RPM/Red hat** -1. Add the repository: - ```shell - cat < netbird will copy any existing configuration from the Wiretrustee's default configuration paths to the new Netbird's default location -3. Install the client - ```shell - # for CLI only - brew install netbirdio/tap/netbird - # for GUI package - brew install --cask netbirdio/tap/netbird-ui - ``` -4. If you are install CLI only, you need to install and start the client daemon service: - ```shell - sudo netbird service install - sudo netbird service start - ``` -**Installation from binary (CLI only)** -1. Checkout Netbird [releases](https://github.com/netbirdio/netbird/releases/latest) -2. Download the latest release (**Switch VERSION to the latest**): - ```shell - curl -o ./netbird__darwin_amd64.tar.gz https://github.com/netbirdio/netbird/releases/download/v/wiretrustee__darwin_amd64.tar.gz - ``` -3. Decompress - ```shell - tar xcf ./netbird__darwin_amd64.tar.gz - sudo mv netbird /usr/bin/netbird - chmod +x /usr/bin/netbird - ``` - After that you may need to add /usr/bin in your PATH environment variable: - ````shell - export PATH=$PATH:/usr/bin - ```` -4. Install and run the service - ```shell - sudo netbird service install - sudo netbird service start - ``` - -#### Windows -1. Checkout Netbird [releases](https://github.com/netbirdio/netbird/releases/latest) -2. Download the latest Windows release installer ```netbird_installer__windows_amd64.exe``` (**Switch VERSION to the latest**): -3. Proceed with installation steps -4. This will install the client in the C:\\Program Files\\Netbird and add the client service -5. After installing, you can follow the [Client Configuration](#Client-Configuration) steps. -> To uninstall the client and service, you can use Add/Remove programs - -### Client Configuration -If you installed the UI client, you can launch it and click on Connect -> It will open your browser, and you will be prompt for email and password - -Simply run: -```shell - netbird up -``` -> It will open your browser, and you will be prompt for email and password - -Check connection status: -```shell - netbird status -``` -In case you are activating a server peer, you can use a setup-key as described in the steps below: - - -1. Login to the Management Service. You need to have a `setup key` in hand (see ). - -For all systems: - ```shell - netbird up --setup-key - ``` - -For **Docker**, you can run with the following command: -```shell -docker run --network host --privileged --rm -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird: -``` -> TAG > 0.6.0 version - -Alternatively, if you are hosting your own Management Service provide `--management-url` property pointing to your Management Service: - ```shell - sudo netbird up --setup-key --management-url http://localhost:33073 - ``` - -> You could also omit the `--setup-key` property. In this case, the tool will prompt for the key. - -2. Check connection status: -```shell - netbird status -``` - -3. Check your IP: - For **MACOS** you will just start the service: - ````shell - sudo ifconfig utun100 - ```` -For **Linux** systems: - ```shell - ip addr show wt0 - ``` -For **Windows** systems: - ```shell - netsh interface ip show config name="wt0" - ``` - -4. Repeat on other machines. - -### Troubleshooting -1. If you are using self-hosted version and haven't specified `--management-url`, the client app will use the default URL - which is ```https://api.wiretrustee.com:33073```. - -2. If you have specified a wrong `--management-url` (e.g., just by mistake when self-hosting) - to override it you can do the following: - - ```shell - netbird down - netbird up --management-url https:/// - ``` - - To override it see solution #1 above. - -### Running Dashboard, Management, Signal and Coturn -See [Self-Hosting Guide](https://netbird.io/docs/getting-started/self-hosting) - - ### Legal [WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.