mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-20 17:36:36 +00:00
add disable profiles docs (#410)
* Enhance CLI and Profiles documentation with environment variable examples and details on disabling profiles feature * Remove deprecated environment variable examples and notes related to the profiles feature in CLI documentation * Enhance CLI and Profiles documentation with additional environment variable examples and details on disabling update settings functionality * Update cli.mdx --------- Co-authored-by: Maycon Santos <mlsmaycon@gmail.com>
This commit is contained in:
@@ -77,6 +77,38 @@ If you're upgrading from NetBird below version `0.52.0` that did not support pro
|
||||
copied to a new profile named `default`.
|
||||
* The `default` profile is set as active, and you can start using it immediately.
|
||||
|
||||
## Disabling Profiles Feature
|
||||
|
||||
In some environments, you may want to disable the profiles feature entirely. This can be useful for:
|
||||
|
||||
* **Managed environments** where users should not be able to switch between different NetBird accounts
|
||||
* **Security policies** that require a single, fixed configuration
|
||||
* **Automated deployments** where profile switching could interfere with operations
|
||||
|
||||
To disable the profiles feature, you can use the `--disable-profiles` flag when installing the service:
|
||||
|
||||
```shell
|
||||
sudo netbird service install --disable-profiles
|
||||
```
|
||||
|
||||
Alternatively, you can set the `NB_DISABLE_PROFILES` environment variable:
|
||||
|
||||
```shell
|
||||
export NB_DISABLE_PROFILES=true
|
||||
sudo netbird service install
|
||||
```
|
||||
|
||||
When profiles are disabled:
|
||||
* Users cannot create, switch, or remove profiles
|
||||
* The profile management UI is disabled
|
||||
* All profile-related CLI commands are disabled
|
||||
* The client operates with a single, fixed configuration
|
||||
* Profile switching is completely prevented
|
||||
|
||||
<Note>
|
||||
You can also disable update settings functionality using the `--disable-update-settings` flag or `NB_DISABLE_UPDATE_SETTINGS` environment variable. This prevents users from modifying any configuration settings, providing an additional layer of control in managed environments.
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## Profile CLI Commands
|
||||
|
||||
Reference in New Issue
Block a user