From 339f66ecbe4c0df4f371aad7d5647dc0eb61334f Mon Sep 17 00:00:00 2001 From: braginini Date: Tue, 23 May 2023 20:32:57 +0200 Subject: [PATCH] Fix links --- src/pages/docs/about-netbird/how-netbird-works.mdx | 6 +++--- .../docs/how-to/enforce-periodic-user-authentication.mdx | 2 +- src/pages/docs/how-to/examples.mdx | 2 +- src/pages/docs/how-to/getting-started.mdx | 8 ++++---- src/pages/docs/how-to/installation.mdx | 8 ++++---- src/pages/docs/how-to/manage-dns-in-your-network.mdx | 2 +- src/pages/docs/how-to/manage-network-access.mdx | 4 ++-- .../docs/how-to/register-machines-using-setup-keys.mdx | 2 +- src/pages/docs/selfhosted/identity-providers.mdx | 4 ++-- src/pages/docs/selfhosted/selfhosted-guide.mdx | 2 +- src/pages/ipa/guides/authentication.mdx | 2 +- src/pages/ipa/introduction.mdx | 4 ++-- 12 files changed, 23 insertions(+), 23 deletions(-) diff --git a/src/pages/docs/about-netbird/how-netbird-works.mdx b/src/pages/docs/about-netbird/how-netbird-works.mdx index 9ab488ff..4f3f2753 100644 --- a/src/pages/docs/about-netbird/how-netbird-works.mdx +++ b/src/pages/docs/about-netbird/how-netbird-works.mdx @@ -27,7 +27,7 @@ With NetBird clients installed and authorized on the Management service, machine high-level-dia

-While it is possible to create a full mesh network, it might be not a desirable outcome. In this case, [ACLs](/docs/how-to/restrict-access-to-peers) can be utilized to limit the access to certain machines. +While it is possible to create a full mesh network, it might be not a desirable outcome. In this case, [ACLs](/docs/how-to/manage-network-access) can be utilized to limit the access to certain machines. Let's now take a closer look at each of NetBird's components. @@ -39,7 +39,7 @@ It keeps the network state, public Wireguard keys of the peers, authenticates an The Management Service's responsibilities include: * **Registering and authenticating new peers.** Every new machine has to register itself in the network in order to connect to other machines. -After installation, NetBird client requires login that can be done through Identity Provider (IDP) or with a [setup key](/docs/how-to/register-peers-using-setup-keys). +After installation, NetBird client requires login that can be done through Identity Provider (IDP) or with a [setup key](/docs/how-to/register-machines-using-setup-keys). * **Keeping the network map.** The Management service stores information about all the registered peers including Wireguard public key that was sent during the registration process. * **Managing private IP addresses.** Each peer receives a unique private IP with which it can be identified in the network. We use [Carrier Grade NAT](https://en.wikipedia.org/wiki/Carrier-grade_NAT) address space with an allocated address block 100.64.0.0/10. @@ -123,7 +123,7 @@ Below is a high level, step-by-step overview of the flow of communications withi 1. Administrator creates an account at [app.netbird.io](https://app.netbird.io/). 2. The system automatically generates a new network with an allocated address block 100.64.0.0/10. -3. The system automatically generates 2 [setup keys](/docs/how-to/register-peers-using-setup-keys) that can be used for authenticating new machines. +3. The system automatically generates 2 [setup keys](/docs/how-to/register-machines-using-setup-keys) that can be used for authenticating new machines. 4. Administrator (or a user) installs NetBird client and runs ```netbird up``` command providing one of the setup keys. 5. NetBird client generates Wireguard private and public keys along with the initial configuration. 6. NetBird client sends a registration request to the NetBird Management service calling Login gRPC endpoint, providing setup key, Wireguard public key and additional information about the machine. diff --git a/src/pages/docs/how-to/enforce-periodic-user-authentication.mdx b/src/pages/docs/how-to/enforce-periodic-user-authentication.mdx index abee839a..cc5268e6 100644 --- a/src/pages/docs/how-to/enforce-periodic-user-authentication.mdx +++ b/src/pages/docs/how-to/enforce-periodic-user-authentication.mdx @@ -5,7 +5,7 @@ To ensure a high level of security, NetBird offers a peer login expiration featu Every new network has this feature enabled, and the expiration period is set to 24 hours by default. You can disable this feature and configure the expiration period in the account settings in the web UI https://app.netbird.io/settings. - This feature is only applied to peers added with the [interactive SSO login feature](/getting-started/installation#running-netbird-with-sso-login). Peers, added with a setup key, won't be affected. + This feature is only applied to peers added with the [interactive SSO login feature](/docs/how-to/installation#running-net-bird-with-sso-login). Peers, added with a setup key, won't be affected. Expired peers will appear in the peers' view with the status `needs login`. diff --git a/src/pages/docs/how-to/examples.mdx b/src/pages/docs/how-to/examples.mdx index f05c0e35..4e55da5a 100644 --- a/src/pages/docs/how-to/examples.mdx +++ b/src/pages/docs/how-to/examples.mdx @@ -100,7 +100,7 @@ One of the simplest ways of running NetBird client application is to use a pre-b * **NetBird account.** Register one at [app.netbird.io](https://app.netbird.io/). -You would need to obtain a [setup key](/docs/how-to/register-peers-using-setup-keys) to associate NetBird client with your account. +You would need to obtain a [setup key](/docs/how-to/register-machines-using-setup-keys) to associate NetBird client with your account. The setup key could be found in the NetBird Management dashboard under the Setup Keys tab - [https://app.netbird.io/setup-keys](https://app.netbird.io/setup-keys). diff --git a/src/pages/docs/how-to/getting-started.mdx b/src/pages/docs/how-to/getting-started.mdx index bde5c4d0..ae0f1980 100644 --- a/src/pages/docs/how-to/getting-started.mdx +++ b/src/pages/docs/how-to/getting-started.mdx @@ -291,10 +291,10 @@ Check connection status: ``` ### Running NetBird with a Setup Key -In case you are activating a server peer, you can use a [setup key](/docs/how-to/register-peers-using-setup-keys) as described in the steps below. +In case you are activating a server peer, you can use a [setup key](/docs/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](/docs/how-to/register-peers-using-setup-keys)). +1. Login to the Management Service. You need to have a `setup key` in hand (see [setup keys](/docs/how-to/register-machines-using-setup-keys)). For all systems: ```bash @@ -338,13 +338,13 @@ On **Windows**: Set the ```NB_SETUP_KEY``` environment variable and run the command. - You can pass other settings as environment variables. See [Environment variables](reference/netbird-commands.md#environment-variables) for details. + You can pass other settings as environment variables. See [environment variables](/docs/how-to/cli#environment-variables) for details. ```bash docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird:latest ``` -See [Docker example](examples/netbird-docker.md) for details. +See [Docker example](/docs/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 diff --git a/src/pages/docs/how-to/installation.mdx b/src/pages/docs/how-to/installation.mdx index cc0ff528..8fda1248 100644 --- a/src/pages/docs/how-to/installation.mdx +++ b/src/pages/docs/how-to/installation.mdx @@ -207,10 +207,10 @@ Check connection status: ``` ### Running NetBird with a Setup Key -In case you are activating a server peer, you can use a [setup key](/docs/how-to/register-peers-using-setup-keys) as described in the steps below. +In case you are activating a server peer, you can use a [setup key](/docs/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](/docs/how-to/register-peers-using-setup-keys)). +1. Login to the Management Service. You need to have a `setup key` in hand (see [setup keys](/docs/how-to/register-machines-using-setup-keys)). For all systems: ```bash @@ -254,13 +254,13 @@ On **Windows**: Set the ```NB_SETUP_KEY``` environment variable and run the command. - You can pass other settings as environment variables. See [Environment variables](reference/netbird-commands.md#environment-variables) for details. + You can pass other settings as environment variables. See [Environment variables](/docs/how-to/cli#environment-variables) for details. ```bash docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY= -v netbird-client:/etc/netbird netbirdio/netbird:latest ``` -See [Docker example](examples/netbird-docker.md) for details. +See [Docker example](/docs/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 diff --git a/src/pages/docs/how-to/manage-dns-in-your-network.mdx b/src/pages/docs/how-to/manage-dns-in-your-network.mdx index 06e5af65..d2e4b657 100644 --- a/src/pages/docs/how-to/manage-dns-in-your-network.mdx +++ b/src/pages/docs/how-to/manage-dns-in-your-network.mdx @@ -18,7 +18,7 @@ Starting [v0.11.0](https://github.com/netbirdio/netbird/releases), NetBird autom to each peer in a private `netbird.cloud` space that can be used to access the machines. E.g., `my-server.netbird.cloud`. Besides accessing machines by their domain names, you can configure NetBird to use your private nameservers, -control what nameservers a specific [peer group](/docs/how-to/access-control#concepts) should use, and set up split DNS. +control what nameservers a specific [peer group](/docs/how-to/manage-network-access#groups) should use, and set up split DNS. Nameservers feature is available in NetBird [v0.11.0](https://github.com/netbirdio/netbird/releases) or later. diff --git a/src/pages/docs/how-to/manage-network-access.mdx b/src/pages/docs/how-to/manage-network-access.mdx index a45433a4..4beb4672 100644 --- a/src/pages/docs/how-to/manage-network-access.mdx +++ b/src/pages/docs/how-to/manage-network-access.mdx @@ -30,7 +30,7 @@ Some characteristics of groups: - There is a default group called `All`. - You can assign groups automatically with the [peer auto-grouping feature](/overview/setup-keys#peer-auto-grouping). + You can assign groups automatically with the [peer auto-grouping feature](/docs/how-to/register-machines-using-setup-keys#peer-auto-grouping). ### The All Group @@ -96,7 +96,7 @@ You can do it by accessing the `Peers` tab and clicking the `Groups` column of a

- You can assign groups automatically with the [peer auto-grouping feature](/overview/setup-keys#peer-auto-grouping). + You can assign groups automatically with the [peer auto-grouping feature](/docs/how-to/register-machines-using-setup-keys#peer-auto-grouping). ### Updating Rules diff --git a/src/pages/docs/how-to/register-machines-using-setup-keys.mdx b/src/pages/docs/how-to/register-machines-using-setup-keys.mdx index 40ac805e..33fb630a 100644 --- a/src/pages/docs/how-to/register-machines-using-setup-keys.mdx +++ b/src/pages/docs/how-to/register-machines-using-setup-keys.mdx @@ -40,7 +40,7 @@ Setup keys are set to expire after 30 days. When expired, the setup key can't be high-level-dia

-NetBird offers a powerful [Access Control feature](/docs/how-to/restrict-access-to-peers) that allows easy access management of your resources. +NetBird offers a powerful [access control feature](/docs/how-to/manage-network-access) that allows easy access management of your resources. In a basic scenario, you would create multiple groups of peers and create access rules to define what groups can access each other. Adding peers to groups might become time-consuming in large networks with dozens of machines. diff --git a/src/pages/docs/selfhosted/identity-providers.mdx b/src/pages/docs/selfhosted/identity-providers.mdx index 6b5361d2..3d3c0841 100644 --- a/src/pages/docs/selfhosted/identity-providers.mdx +++ b/src/pages/docs/selfhosted/identity-providers.mdx @@ -61,8 +61,8 @@ This Auth0 API will be used to access NetBird Management Service API. ### Step 4: Enable Interactive SSO Login (Optional) -The [Interactive SSO Login feature](/getting-started/installation#running-netbird-with-sso-login) allows for machine -authorization with your Identity Provider. This feature can be used as an alternative to [setup keys](docs/how-to/register-peers-using-setup-keys) +The [Interactive SSO Login feature](/docs/how-to/installation#running-net-bird-with-sso-login) allows for machine +authorization with your Identity Provider. This feature can be used as an alternative to [setup keys](/docs/how-to/register-machines-using-setup-keys) and is optional. You can enable it by following these steps: diff --git a/src/pages/docs/selfhosted/selfhosted-guide.mdx b/src/pages/docs/selfhosted/selfhosted-guide.mdx index 1c565806..c4d176bb 100644 --- a/src/pages/docs/selfhosted/selfhosted-guide.mdx +++ b/src/pages/docs/selfhosted/selfhosted-guide.mdx @@ -6,7 +6,7 @@ NetBird is open-source and can be self-hosted on your servers. It relies on components developed by NetBird Authors [Management Service](https://github.com/netbirdio/netbird/tree/main/management), [Management UI Dashboard](https://github.com/netbirdio/dashboard), [Signal Service](https://github.com/netbirdio/netbird/tree/main/signal), a 3rd party open-source STUN/TURN service [Coturn](https://github.com/coturn/coturn), and an identity provider (available options will be listed later in this guide). -If you would like to learn more about the architecture please refer to the [Architecture section](/overview/architecture). +If you would like to learn more about the architecture please refer to the [Architecture section](/docs/about-netbird/how-netbird-works). It might be a good idea to try NetBird before self-hosting. diff --git a/src/pages/ipa/guides/authentication.mdx b/src/pages/ipa/guides/authentication.mdx index 859b2b0c..9fceadc8 100644 --- a/src/pages/ipa/guides/authentication.mdx +++ b/src/pages/ipa/guides/authentication.mdx @@ -28,6 +28,6 @@ curl https://api.netbird.io/api/users \ Always keep your token safe and reset it if you suspect it has been compromised.
-
diff --git a/src/pages/ipa/introduction.mdx b/src/pages/ipa/introduction.mdx index 80862c8d..5d21654a 100644 --- a/src/pages/ipa/introduction.mdx +++ b/src/pages/ipa/introduction.mdx @@ -14,12 +14,12 @@ Use the NetBird Public API to manage users, peers, network rules and more from i ## Getting started {{ anchor: false }} -To get started, it is recommended to create a [service user](/docs/how-to/use-service-users-with-access-token#service-users), that can later be used to communicate with the NetBird API. +To get started, it is recommended to create a [service user](/docs/how-to/access-netbird-public-api#creating-a-service-user), that can later be used to communicate with the NetBird API. To be able to send requests to our API you need to [authenticate](/api/guides/authentication) on each request. This can be done either by Bearer token from your identity provider or by creating a [personal access token](/api/guides/authentication#using-personal-access-tokens) in the NetBird dashboard.{{ className: 'lead' }}