Add a Maintenance Section (#580)

* Add a Maintenance section

* Move the self-host section higher

* Add references to backup and upgrade
This commit is contained in:
Misha Bragin
2026-01-27 12:29:05 +01:00
committed by GitHub
parent 4701c0f954
commit 75164d3aef
7 changed files with 159 additions and 63 deletions

View File

@@ -128,58 +128,28 @@ NetBird includes built-in local user management powered by an embedded <a href="
]}
/>
## Maintenance
Once your NetBird instance is running, refer to these guides for ongoing maintenance:
<Tiles
id="maintenance"
items={[
{
href: '/selfhosted/maintenance/backup',
name: 'Backup',
description: 'Back up your NetBird configuration and data to protect against data loss.',
},
{
href: '/selfhosted/maintenance/upgrade',
name: 'Upgrade',
description: 'Upgrade your NetBird installation to the latest version.',
},
]}
/>
---
## Manage Installation
### Backup
To back up your NetBird installation, you need to copy the configuration files and the Management service databases.
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 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
docker compose cp -a management:/var/lib/netbird/ backup/
docker compose start management
```
### Upgrade
To upgrade NetBird to the latest version:
1. Run the backup steps described in the [backup](#backup) section.
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
```
4. Restart the NetBird containers with the new images:
```bash
docker compose up -d --force-recreate management dashboard signal relay
```
<Note>
For upgrades from older versions (pre-v0.26.0), see the [Legacy upgrade notes](#legacy-self-hosting-with-zitadel-idp).
</Note>
### Remove
To remove the NetBird installation and all related data from your server, run these commands from the folder where you installed NetBird:
```bash
# 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 management.json relay.env
```
## Troubleshoot
- **I can't access the `/setup` page**
@@ -198,7 +168,7 @@ For more troubleshooting help, see the [Troubleshooting guide](/selfhosted/troub
---
## Get in touch
## Get In Touch
Feel free to ping us on [Slack](/slack-url) if you have any questions.