diff --git a/public/docs-static/img/getting-started/systray.png b/public/docs-static/img/getting-started/systray.png index 90d34f01..3fd86aab 100644 Binary files a/public/docs-static/img/getting-started/systray.png and b/public/docs-static/img/getting-started/systray.png differ diff --git a/src/pages/how-to/getting-started.mdx b/src/pages/how-to/getting-started.mdx index 03d9b1a2..10ff6521 100644 --- a/src/pages/how-to/getting-started.mdx +++ b/src/pages/how-to/getting-started.mdx @@ -71,12 +71,12 @@ sudo netbird up On your laptop: ```bash -ping 100.64.0.2 +ping ec2-demo-node.netbird.cloud ``` On the EC2 node: ```bash -ping 100.64.0.1 +ping my-linux-laptop.netbird.cloud ``` 10. Done! You now have a secure peer-to-peer private network configured. @@ -86,282 +86,3 @@ ping 100.64.0.1 - Follow us [on Twitter](https://twitter.com/netbird) - Join our [Slack Channel](https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A) - NetBird release page on GitHub: [releases](https://github.com/netbirdio/netbird/releases/latest) - -## Installation - -### Linux - -**APT/Debian** -1. Add the repository: - - ```bash - sudo apt-get update - sudo apt-get install ca-certificates curl gnupg -y - curl -sSL https://pkgs.netbird.io/debian/public.key | sudo gpg --dearmor --output /usr/share/keyrings/netbird-archive-keyring.gpg - echo 'deb [signed-by=/usr/share/keyrings/netbird-archive-keyring.gpg] https://pkgs.netbird.io/debian stable main' | sudo tee /etc/apt/sources.list.d/netbird.list -``` -2. Update APT's cache - -```bash - sudo apt-get update -``` -3. Install the package - -```bash - # for CLI only - sudo apt-get install netbird - # for GUI package - sudo apt-get install netbird-ui -``` - -**RPM/Red hat** - -1. Add the repository: -```bash - cat < netbird will copy any existing configuration from the netbird's default configuration paths to the new NetBird's default location - -3. Install the client -```bash - # for CLI only - brew install netbirdio/tap/netbird - # for GUI package - brew install --cask netbirdio/tap/netbird-ui -``` -4. If you installed CLI only, you need to install and start the client daemon service: - ```bash - 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 the installation steps -4. This will install the UI client in the C:\\Program Files\\NetBird and add the daemon service -5. After installing, you can follow the steps from [Running NetBird with SSO Login](#Running-NetBird-with-SSO-Login) steps. -> To uninstall the client and service, you can use Add/Remove programs - -⚠️ In case of any issues with the connection on Windows check the firewall settings. With default Windows 11 firewall setup there could be connectivity issue related to egress traffic. - -Recommended way is to add NetBird in firewall settings: - -1. Go to "Control panel". -2. Select "Windows Defender Firewall". -3. Select "Advanced settings". -4. Select "Outbound Rules" -> "New rule". -5. In the new rule select "Program" and click "Next". -6. Point to the NetBird installation exe file (usually in `C:\Program Files\NetBird\netbird.exe`) and click "Next". -7. Select "Allow the connection" and click "Next". -8. Select the network in which rule should be applied (Domain, Private, Public) according to your needs and click "Next". -9. Provide rule name (e.g. "Netbird Egress Traffic") and click "Finish". -10. Disconnect and connect to NetBird. - - -### Binary Install -**Installation from binary (CLI only)** - -1. Checkout NetBird [releases](https://github.com/netbirdio/netbird/releases/latest) -2. Download the latest release: -```bash - curl -L -o ./netbird_.tar.gz https://github.com/netbirdio/netbird/releases/download/v/netbird___.tar.gz -``` - - - - You need to replace some variables from the URL above: - - - Replace **VERSION** with the latest released version. - - Replace **OS** with "linux", "darwin" for MacOS or "windows" - - Replace **Arch** with your target system CPU architecture - - - -3. Decompress -```bash - tar xcf ./netbird_.tar.gz - sudo mv netbird /usr/bin/netbird - sudo chown root:root /usr/bin/netbird - sudo chmod +x /usr/bin/netbird -``` -After that you may need to add /usr/bin in your PATH environment variable: -````bash - export PATH=$PATH:/usr/bin -```` -4. Install and run the service -```bash - sudo netbird service install - sudo netbird service start -``` - -### Running NetBird with SSO Login -#### Desktop UI Application -If you installed the Desktop UI client, you can launch it and click on Connect. -> It will open your browser, and you will be prompt for email and password. Follow the instructions. - -

- high-level-dia -

- -#### CLI -Alternatively, you could use command line. Simply run - ```bash - netbird up - ``` -> It will open your browser, and you will be prompt for email and password. Follow the instructions. - -

- high-level-dia -

- -Check connection status: -```bash - netbird status -``` - -### Running NetBird with a Setup Key -In case you are activating a server peer, you can use a [setup key](/how-to/register-machines-using-setup-keys) as described in the steps below. -> This is especially helpful when you are running multiple server instances with infrastructure-as-code tools like ansible and terraform. - -1. Login to the Management Service. You need to have a `setup key` in hand (see [setup keys](/how-to/register-machines-using-setup-keys)). - -For all systems: -```bash - netbird up --setup-key -``` - -For **Docker**, you can run with the following command: -```bash -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: -```bash - 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: -```bash - netbird status -``` - -3. Check your IP: - -On **macOS** : -````bash - sudo ifconfig utun100 -```` -On **Linux**: -```bash - ip addr show wt0 - ``` -On **Windows**: -```bash - netsh interface ip show config name="wt0" -``` - -### Running NetBird in Docker - -Set the ```NB_SETUP_KEY``` environment variable and run the command. - - - You can pass other settings as environment variables. See [environment variables](/how-to/cli#environment-variables) for details. - - -NetBird makes use of eBPF and raw sockets, therefore to guarantee the client software functionality, we recommend adding the flags `--cap-add=SYS_ADMIN` and `--cap-add=SYS_RESOURCE` for docker clients. -The experience may vary depending on the docker daemon, operating system, or kernel version. - -```bash -docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN --cap-add=SYS_ADMIN --cap-add=SYS_RESOURCE -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird:latest -``` - -See [Docker example](/how-to/examples#net-bird-client-in-docker) for details. - -### 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: - -```bash -netbird down -netbird up --management-url https:/// -``` - -To override it see the solution #1 above.