mirror of
https://github.com/netbirdio/dashboard.git
synced 2026-01-26 01:21:04 +00:00
2b222e082a
* Init Dashboard V2 * Update README.md * use dedicated vars and prevent docker push on PRs --------- Co-authored-by: Maycon Santos <mlsmaycon@gmail.com>
23 lines
1.1 KiB
Markdown
23 lines
1.1 KiB
Markdown
# NetBird Dashboard
|
|
NetBird Dashboard is NetBirds Management server UI. It allows users to signin, view setup keys and manage peers. This image is **not ready** for production use.
|
|
## Tags
|
|
```latest``` ```vX.X.X``` not available yet.
|
|
|
|
```main``` built on every PR being merged to the repository
|
|
## How to use this image
|
|
HTTP run:
|
|
```shell
|
|
docker run -d --rm -p 80:80 wiretrustee/dashboard:main
|
|
```
|
|
Using SSL certificate from Let's Encrypt®:
|
|
```shell
|
|
docker run -d --rm -p 80:80 -p 443:443 \
|
|
-e LETSENCRYPT_DOMAIN=app.mydomain.com \
|
|
-e LETSENCRYPT_EMAIL=hello@mydomain.com \
|
|
netbirdio/dashboard:main
|
|
```
|
|
> For SSL generation, you need to run this image in a server with proper public IP and a domain name pointing to it.
|
|
## Environment variables
|
|
* ```NGINX_SSL_PORT``` Changes the port that Nginx listens to. Defaults to ```443```
|
|
* ```LETSENCRYPT_DOMAIN``` Enables Certbot`s client execution for the specified domain. Defaults to ```none```
|
|
* ```LETSENCRYPT_EMAIL``` Email used in Certbot`s client execution to register the certificate request. Defaults to ```example@local``` |