sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-19 00:46:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Config file breakdown (#565)

Browse Source
This commit is contained in:
shuuri-labs
2026-01-22 16:38:32 +01:00
committed by GitHub
parent b5ce088750
commit 4b5f9b58dc
5 changed files with 889 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/pages/selfhosted/selfhosted-quickstart.mdx
View File

@@ -30,7 +30,8 @@ Download and run the installation script:
curl -fsSL https://github.com/netbirdio/netbird/releases/latest/download/getting-started.sh | bash
```
Once finished, you can manage the resources via `docker compose`.
Once finished, you can manage the resources via `docker compose`. The quick start script generates a full, production-ready NetBird installation. If you'd like to customize the install or gain a better understanding of the files
generated by the script, including the docker compose file, please refer to our [Configuration files](/selfhosted/configuration-files) guide.
### Reverse Proxy Selection
@@ -72,12 +73,11 @@ Rendering initial files...
Starting NetBird services
[+] Running 6/6
[+] Running 5/5
✔ Network netbird Created
✔ Container netbird-dashboard Started
✔ Container netbird-management Started
✔ Container netbird-relay Started
✔ Container netbird-coturn Started
✔ Container netbird-signal Started
✔ Container netbird-caddy Started
Waiting for Management server to become ready . . done
@@ -139,8 +139,12 @@ To back up your NetBird installation, you need to copy the configuration files a
The configuration files are located in the folder where you ran the installation script. To back up, copy the files to a backup location:
```bash
mkdir backup
cp docker-compose.yml Caddyfile dashboard.env turnserver.conf management.json relay.env backup/
cp docker-compose.yml Caddyfile dashboard.env management.json relay.env backup/
```
<Note>
For detailed information about each configuration file and its options, see the [Configuration Files Reference](/selfhosted/configuration-files).
</Note>
To save the Management service databases, stop the Management service and copy the files from the store directory:
```bash
docker compose stop management
@@ -156,11 +160,11 @@ To upgrade NetBird to the latest version:
2. Review the [release notes](https://github.com/netbirdio/netbird/releases) for any breaking changes.
3. Pull the latest NetBird docker images:
```bash
docker compose pull management dashboard signal relay coturn
docker compose pull management dashboard signal relay
```
4. Restart the NetBird containers with the new images:
```bash
docker compose up -d --force-recreate management dashboard signal relay coturn
docker compose up -d --force-recreate management dashboard signal relay
```
<Note>
@@ -173,7 +177,7 @@ To remove the NetBird installation and all related data from your server, run th
# remove all NetBird-related containers and volumes (data)
docker compose down --volumes
# remove downloaded and generated config files
rm -f docker-compose.yml Caddyfile dashboard.env turnserver.conf management.json relay.env
rm -f docker-compose.yml Caddyfile dashboard.env management.json relay.env
```
## Troubleshoot