sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-10-17 11:09:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updates for the NetBird 0.75 update (#881)

Browse Source
This commit is contained in:
PizzaLovingNerd
2026-07-24 07:43:56 -07:00
committed by GitHub
parent f6ee418c4b
commit b867aa85c8
32 changed files with 303 additions and 269 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/client/profiles.mdx
+21 -37
View File
@@ -7,47 +7,29 @@ This feature also allows you to switch between self-hosted and cloud-hosted NetB
to juggle multiple config files.
<p>
<img src="/docs-static/img/client/profiles/profiles.png" alt="profiles" className="imagewrapper"/>
<img src="/docs-static/img/client/profiles/profiles.png" alt="Profile selector in the NetBird desktop app" className="imagewrapper"/>
</p>
Watch a short demo GIF demonstrating how profile switching works [here](/docs-static/img/client/profiles/profiles.gif).
## NetBird Profiles GUI Quickstart
To get started with NetBird profiles:
1. Open the desktop app. NetBird creates a `default` profile automatically.
2. Open **Settings → Profiles** and select **Add profile**.
3. Give the profile a recognizable name and configure whether it connects to NetBird Cloud or a self-hosted management URL.
4. Select the profile from the selector in the main window or tray menu.
- Upgrade your client application to the latest NetBird version.
- Run the GUI app
You will see a `default` profile created automatically.
Add more profiles by hovering over the default profile and clicking "Manage Profiles".
After adding a new profile, select it to make it active.
You can now change the NetBird settings, e.g., providing a self-hosted
instance URL or allowing SSH. The new settings will be saved in the new profile. Click "Connect" to bring up the new profile.
The consequent selection of your profiles from the menu will automatically trigger the NetBird client to connect to the network and authentication
if needed.
Selecting a profile makes it active and connects automatically. The first time you use a profile, NetBird opens the browser authentication flow if needed. Later switches reuse that profile's saved login state. While the Profiles settings page is open for management, selecting a profile does not interrupt the profile you are editing.
## Manage Profiles in the GUI
* **Add** a new profile with a friendly name input. Names need not be unique, each profile is tracked by its own generated ID.
* **Delete** any inactive profile (trash icon).
* **Active and default** profiles cannot be removed.
Open **Settings → Profiles** to:
* **Add** a profile with a friendly name. Names need not be unique because each profile has a generated ID.
* **Edit or rename** an existing profile, including its management URL.
* **Delete** any inactive profile. Active and default profiles cannot be removed.
* Recognize profiles by their assigned Work, Home, Default, or other type icon.
<p>
<img src="/docs-static/img/client/profiles/manage-profiles.png" alt="profiles" className="imagewrapper"/>
</p>
<Note>
The redesigned desktop app, currently available as a **release candidate**, expands profile management. You can now **rename and edit** existing profiles, not just add and delete them. Profile names accept uppercase letters and spaces, so names like `Work Prod` or `Home Lab` are valid. Each profile is assigned an **icon based on its type** (Work, Home, Default, and others) so the active profile is easy to recognize in the tray and switcher.
In the new app, profiles are managed from the dedicated **Profiles** tab in Settings.
</Note>
<p>
<img src="/docs-static/img/client/profiles/profiles-edit.png" alt="Editing and renaming profiles in the new desktop app" className="imagewrapper"/>
<img src="/docs-static/img/client/profiles/profiles-edit.png" alt="Profiles settings in the NetBird desktop app" className="imagewrapper"/>
</p>
## What Is a Profile?
@@ -74,13 +56,15 @@ Each profile has two parts:
The `default` profile is special: its ID is always `default`. You can rename its display label,
but it keeps that reserved ID and cannot be removed.
Profiles live in your system or user config folders, stored as `<id>.json`:
The default profile is stored as `default.json` in NetBird's state directory. Additional service profiles are stored under a per-user subdirectory as `<id>.json`:
| OS | Config path |
| ------ | --------------------------------- |
| Linux | `/var/lib/netbird/...` |
| macOS | `/var/lib/netbird...`|
| Windows| `%ProgramData%\Netbird\profiles\` |
| OS | Default state directory | Additional profile example |
| --- | --- | --- |
| Linux and macOS | `/var/lib/netbird/` | `/var/lib/netbird/<username>/<id>.json` |
| FreeBSD | `/var/db/netbird/` | `/var/db/netbird/<username>/<id>.json` |
| Windows | `%ProgramData%\Netbird\` | `%ProgramData%\Netbird\<username>\<id>.json` |
`NB_STATE_DIR` overrides the default state directory. Treat profile files as credentials: stop the service before manual maintenance, restrict access, and prefer the GUI or CLI for normal profile management.
---