Fix minor docs issues

This commit is contained in:
braginini
2022-08-18 11:27:57 +02:00
parent 81885773d9
commit 26a7d24692
2 changed files with 4 additions and 5 deletions

View File

@@ -23,7 +23,7 @@ We run NetBird in the cloud, and it will take less than 5 minutes to get started
- Docker Compose installed (see [Install Docker Compose](https://docs.docker.com/compose/install/)). - Docker Compose installed (see [Install Docker Compose](https://docs.docker.com/compose/install/)).
- Domain name pointing to the public IP address of your server. - Domain name pointing to the public IP address of your server.
- Open TCP ports ```80, 443, 33073, 10000``` (Dashboard HTTP & HTTPS, Management gRCP & HTTP APIs, Signal gRPC API respectively) on your server. - Open TCP ports ```80, 443, 33073, 10000``` (Dashboard HTTP & HTTPS, Management gRCP & HTTP APIs, Signal gRPC API respectively) on your server.
- Coturn is used for relay using the STUN/TURN protocols. It requires a listening port, UDP 3478, and range of ports, UDP 49152-65535, for dynamic relay connections. These are set as defaults in setup file, but can be configured to your requirements. - Coturn is used for relay using the STUN/TURN protocols. It requires a listening port, `UDP 3478`, and range of ports, `UDP 49152-65535`, for dynamic relay connections. These are set as defaults in setup file, but can be configured to your requirements.
- Maybe a cup of coffee or tea :) - Maybe a cup of coffee or tea :)
For this tutorial we will be using domain ```demo.netbird.io``` which points to our Ubuntu 22.04 machine hosted at Hetzner. For this tutorial we will be using domain ```demo.netbird.io``` which points to our Ubuntu 22.04 machine hosted at Hetzner.
@@ -73,9 +73,8 @@ NETBIRD_LETSENCRYPT_EMAIL=""
``` ```
- Set ```NETBIRD_DOMAIN``` to your domain, e.g. `demo.netbird.io` - Set ```NETBIRD_DOMAIN``` to your domain, e.g. `demo.netbird.io`
- Configure ```NETBIRD_LETSENCRYPT_EMAIL``` property: - Configure ```NETBIRD_LETSENCRYPT_EMAIL``` property.
This can be any email address. [Let's Encrypt](https://letsencrypt.org/) will create an account while generating a new certificate.
This can be any email address. [Let's Encrypt](https://letsencrypt.org/) will create an account while generating a new certificate.
:::tip :::tip
Let's Encrypt will notify you via this email when certificates are about to expire. NetBird supports automatic renewal by default. Let's Encrypt will notify you via this email when certificates are about to expire. NetBird supports automatic renewal by default.

View File

@@ -25,7 +25,7 @@ The following guide is an adapted version of the original
### Step 1: Check your Keycloak Instance ### Step 1: Check your Keycloak Instance
For this guide, you need a fully configured Keycloak instance running with configured SSL. For this guide, you need a fully configured Keycloak instance running with SSL.
We assume that your Keycloak instance is available at https://YOUR-KEYCLOAK-HOST:443. We assume that your Keycloak instance is available at https://YOUR-KEYCLOAK-HOST:443.
Feel free to change the port if you have configured Keycloak with a different one. Feel free to change the port if you have configured Keycloak with a different one.