From c6341e000f569268ea7da9cbe0137ba31fb574c2 Mon Sep 17 00:00:00 2001 From: raghvendra <35917821+fork-boy@users.noreply.github.com> Date: Mon, 9 Feb 2026 09:11:09 +0530 Subject: [PATCH] docs: fix broken Auth0 quickstart link in README (#548) * docs: fix broken Auth0 quickstart link * docs: spell error fixes in readme * docs: fix typo in NETBIRD_MGMT_API_ENDPOINT placeholder in readme --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a134fae..6c5ddb5 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ See [NetBird repo](https://github.com/netbirdio/netbird) The purpose of this project is simple - make it easy to manage VPN built with [NetBird](https://github.com/netbirdio/netbird). The dashboard makes it possible to: + - track the status of your peers - remove peers - manage Setup Keys (to authenticate new peers) @@ -17,10 +18,10 @@ The dashboard makes it possible to: - define access controls ## Some Screenshots + peers add-peer - ## Technologies Used - NextJS @@ -33,8 +34,9 @@ The dashboard makes it possible to: - Let's Encrypt ## How to run + Disclaimer. We believe that proper user management system is not a trivial task and requires quite some effort to make it right. Therefore we decided to -use Auth0 service that covers all our needs (user management, social login, JTW for the management API). +use Auth0 service that covers all our needs (user management, social login, JWT for the management API). Auth0 so far is the only 3rd party dependency that can't be really self-hosted. 1. Install [Docker](https://docs.docker.com/get-docker/) @@ -43,9 +45,9 @@ Auth0 so far is the only 3rd party dependency that can't be really self-hosted. `AUTH0_DOMAIN` `AUTH0_CLIENT_ID` `AUTH0_AUDIENCE` - To obtain these, please use [Auth0 React SDK Guide](https://auth0.com/docs/quickstart/spa/react/01-login#configure-auth0) up until "Configure Allowed Web Origins" + To obtain these, please use [Auth0 React SDK Guide](https://auth0.com/docs/quickstart/spa/react) up until "Configure Allowed Web Origins" -4. NetBird UI Dashboard uses NetBirds Management Service HTTP API, so setting `NETBIRD_MGMT_API_ENDPOINT` is required. Most likely it will be `http://localhost:33071` if you are hosting Management API on the same server. +4. NetBird UI Dashboard uses NetBird's Management Service HTTP API, so setting `NETBIRD_MGMT_API_ENDPOINT` is required. Most likely it will be `http://localhost:33071` if you are hosting Management API on the same server. 5. Run docker container without SSL (Let's Encrypt): ```shell @@ -54,9 +56,10 @@ Auth0 so far is the only 3rd party dependency that can't be really self-hosted. -e AUTH0_DOMAIN= \ -e AUTH0_CLIENT_ID= \ -e AUTH0_AUDIENCE= \ - -e NETBIRD_MGMT_API_ENDPOINT= \ + -e NETBIRD_MGMT_API_ENDPOINT= \ netbirdio/dashboard:main ``` + 6. Run docker container with SSL (Let's Encrypt): ```shell @@ -68,7 +71,7 @@ Auth0 so far is the only 3rd party dependency that can't be really self-hosted. -e AUTH0_DOMAIN= \ -e AUTH0_CLIENT_ID= \ -e AUTH0_AUDIENCE= \ - -e NETBIRD_MGMT_API_ENDPOINT= \ + -e NETBIRD_MGMT_API_ENDPOINT= \ netbirdio/dashboard:main ``` @@ -84,11 +87,11 @@ Open [http://localhost:3000](http://localhost:3000) with your browser to see the You can start editing by modifying the code inside `src/..` The page auto-updates as you edit the file. -## How to migrate from old dashboard (v1) +## How to migrate from old dashboard (v1) The new dashboard comes with a new docker image `netbirdio/dashboard:main`. To migrate from the old dashboard (v1) `wiretrustee/dashboard:main` to the new one, please follow the steps below. 1. Stop the dashboard container `docker compose down dashboard` 2. Replace the docker image name in your `docker-compose.yml` with `netbirdio/dashboard:main` -3. Recreate the dashboard container `docker compose up -d --force-recreate dashboard` \ No newline at end of file +3. Recreate the dashboard container `docker compose up -d --force-recreate dashboard`