diff --git a/README.md b/README.md index f2767ca..2ee426f 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,20 @@ # NetBird dashboard -### Big News! Wiretrustee becomes `NetBird`. [See details](https://blog.netbird.io/wiretrustee-becomes-netbird). -\ -This project is the UI for NetBird's management service. +This project is the UI for NetBird's Management service. -**Hosted demo version:** https://app.netbird.io/ +**Hosted version:** https://app.netbird.io/ See [NetBird repo](https://github.com/netbirdio/netbird) -## Why UI dashboard is needed? +## Why? 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 +- remove peers - manage Setup Keys (to authenticate new peers) -- monitor system activity (coming soon) -- manage peer access (coming soon) +- list users +- define access controls ## Some Screenshots auth @@ -27,11 +25,11 @@ The dashboard makes it possible to: ## Technologies Used - ReactJS -- Tailwind CSS. We are using paid License of [TailwindUI](https://tailwindui.com/) +- AntD UI framework - Auth0 -- Nginx +- Nginx - Docker -- Letsencrypt +- 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 @@ -40,18 +38,18 @@ 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/) 2. register [Auth0](https://auth0.com/) account -3. running Wiretrustee UI Dashboard requires the following Auth0 environmental variables to be set (see docker command below): +3. running Wiretrustee UI Dashboard requires the following Auth0 environmental variables to be set (see docker command below): - ```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" + ```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" 4. Wiretrustee UI Dashboard uses Wiretrustee Management Service HTTP API, so setting ```WIRETRUSTEE_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): - + ```docker run -d --name wiretrustee-dashboard --rm -p 80:80 -p 443:443 -e AUTH0_DOMAIN= -e AUTH0_CLIENT_ID= -e AUTH0_AUDIENCE= -e WIRETRUSTEE_MGMT_API_ENDPOINT= wiretrustee/dashboard:main``` 6. Run docker container with SSL (Let's Encrypt): - + ```docker run -d --name wiretrustee-dashboard --rm -p 80:80 -p 443:443 -e NGINX_SSL_PORT=443 -e LETSENCRYPT_DOMAIN= -e LETSENCRYPT_EMAIL= -e AUTH0_DOMAIN= -e AUTH0_CLIENT_ID= -e AUTH0_AUDIENCE= -e WIRETRUSTEE_MGMT_API_ENDPOINT= wiretrustee/dashboard:main``` ## How to run local development diff --git a/media/add-peer.png b/media/add-peer.png index b2c6b71..e2c8ce3 100644 Binary files a/media/add-peer.png and b/media/add-peer.png differ diff --git a/media/auth.png b/media/auth.png index c06c0d8..34bbfff 100644 Binary files a/media/auth.png and b/media/auth.png differ diff --git a/media/peers.png b/media/peers.png index 4bfc096..8a980ac 100644 Binary files a/media/peers.png and b/media/peers.png differ