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

Update Quickstart

Browse Source
This commit is contained in:
Brandon Hopkins
2026-01-06 15:25:25 -08:00
parent 7c337e8fee
commit 3af9935f41
1 changed files with 28 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -59,17 +59,20 @@ The script deploys NetBird **without any users**. Once complete, you'll need to
3. Create your admin account:
- Enter your email address
- Enter your name
- Enter a password
- Click **Create Account**
A password will be generated and displayed. Copy it securely—it will only be shown once. You can then log in with your email and the generated password.
You can then log in with your email and password.
<Note>
The `/setup` page is only accessible when no users exist. After creating the first user, it redirects to the regular login page.
</Note>
### Add more local users
### Add more users
You can add additional local users directly from the NetBird Dashboard—no external identity provider needed:
#### Local users
You can add users directly from the NetBird Dashboard:
1. Navigate to **Team** → **Users**
2. Click **Create User**
@@ -78,9 +81,9 @@ You can add additional local users directly from the NetBird Dashboard—no exte
A password will be generated and displayed once. Share this securely with the user—it cannot be retrieved later.
### Connect identity providers (Optional)
#### Via Identity Provider (Optional)
Local users work great on their own, but if you want users to sign in with their existing accounts from Google, Microsoft, Okta, or other providers, you can connect external identity providers:
If you want users to sign in with their existing accounts from Google, Microsoft, Okta, or other providers, you can connect external identity providers:
1. Navigate to **Settings** → **Identity Providers**
2. Click **Add Identity Provider**
@@ -88,7 +91,7 @@ Local users work great on their own, but if you want users to sign in with their
4. Enter the OAuth client credentials from your provider
5. Click **Save**
**Multiple providers supported**: You can add as many OIDC-compatible identity providers as you need. Users will see all configured providers as login options.
You can add multiple identity providers. Users will see all configured providers as login options.
For detailed setup guides, see [Identity Providers](/selfhosted/identity-providers).
@@ -109,23 +112,24 @@ docker compose start management
```
### Upgrade
<Note>
The users with management on version < [v0.15.3](https://github.com/netbirdio/netbird/releases/tag/v0.15.3)
should first upgrade their systems to [v0.25.9](https://github.com/netbirdio/netbird/releases/tag/v0.25.9),
run management to properly migrate rules to policies, and then upgrade to **0.26.0+**.
</Note>
To upgrade NetBird to the latest version, you need to review the [release notes](https://github.com/netbirdio/netbird/releases) for any breaking changes and follow the upgrade steps below:
To upgrade NetBird to the latest version:
1. Run the backup steps described in the [backup](#backup) section.
2. Pull the latest NetBird docker images:
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
```
3. Restart the NetBird containers with the new images:
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>
### Support browser clients
If you deployed NetBird before version **0.59.0** and want to use browser clients, you need to update your Signal, Management, Dashboard and Relay services, see [Upgrade](#upgrade), then you need to edit the `Caddyfile` file to enable support for browser clients by adding the following lines to the `Caddyfile`:
```
@@ -167,10 +171,10 @@ For more troubleshooting help, see the [Troubleshooting guide](/selfhosted/troub
## Legacy: Self-hosting with Zitadel IdP
<Note>
This section is for users who prefer to use Zitadel as a standalone IdP instead of local user management. For new installations, we recommend the [quickstart approach](#quick-self-hosting) above—you can always add Zitadel as an external identity provider later if needed.
**Deprecated**: This method is no longer recommended for new installations. It is preserved as a reference for users who deployed NetBird using the Zitadel quickstart script prior to version X.XX. For new installations, use the [quickstart approach](#quick-self-hosting) above.
</Note>
If you want to deploy NetBird with [Zitadel](https://zitadel.com/) as the identity provider, you can use the legacy quickstart script:
The following instructions apply to deployments using the `getting-started-with-zitadel.sh` script, which bundled Zitadel as an external identity provider.
### Download and run the script
@@ -227,6 +231,14 @@ If you have an existing Zitadel deployment and want to migrate:
See the [Migration Guide](/selfhosted/identity-providers#migration-guide) for detailed steps.
### Upgrade (Legacy)
<Note>
If upgrading from management version < [v0.15.3](https://github.com/netbirdio/netbird/releases/tag/v0.15.3),
first upgrade to [v0.25.9](https://github.com/netbirdio/netbird/releases/tag/v0.25.9),
run management to migrate rules to policies, then upgrade to **0.26.0+**.
</Note>
---
## Get in touch