Config file breakdown #565
Merged
+889
−17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…yments Adds comprehensive documentation for all NetBird self-hosted configuration files including docker-compose.yml, management.json, relay.env, dashboard.env, and turnserver.conf
… more context for certain files and values
braginini
reviewed
Jan 21, 2026
braginini
reviewed
Jan 21, 2026
…ard built-in nginx, signal legacy port 10000
braginini
reviewed
Jan 22, 2026
braginini
reviewed
Jan 22, 2026
braginini
reviewed
Jan 22, 2026
braginini
reviewed
Jan 22, 2026
braginini
reviewed
Jan 22, 2026
braginini
reviewed
Jan 22, 2026
| | `EmbeddedIdP` | Yes | Enables and configures the built-in identity provider (based on DEX). Handles user authentication, token issuance, and OIDC endpoints. Required for `getting-started.sh` deployments. | | ||
| | `ReverseProxy` | No | Defines trusted proxy IP ranges for accurate client IP detection. Configure this when running behind a load balancer or reverse proxy to ensure correct IP logging and rate limiting. | | ||
| | `StoreConfig` | No | Specifies the database engine (SQLite, PostgreSQL, or MySQL). Defaults to SQLite. Use PostgreSQL for production deployments requiring high availability or concurrent access. | | ||
| | `TURNConfig` | No | Legacy configuration for external TURN servers like coturn. Not used in standard deployments since the relay service handles NAT traversal. Only needed for advanced scenarios. | |
Contributor
There was a problem hiding this comment.
I think we should remove this
braginini
reviewed
Jan 22, 2026
braginini
reviewed
Jan 22, 2026
| The relay secret must be identical in both `management.json` and the relay service environment. A mismatch will cause relay connections to fail. | ||
| </Warning> | ||
|
|
||
| ### Signal Section |
Contributor
There was a problem hiding this comment.
I wouldn't mention 10000 port anymore, here and in other places of this guide.
Also no need for all that legacy signal mentions.
braginini
reviewed
Jan 22, 2026
| ## See Also | ||
|
|
||
| - [Self-hosting Quickstart Guide](/selfhosted/selfhosted-quickstart) - Get started quickly with default settings | ||
| - [Advanced Self-hosting Guide](/selfhosted/selfhosted-guide) - Custom IdP integration |
Contributor
There was a problem hiding this comment.
Suggested change
| - [Advanced Self-hosting Guide](/selfhosted/selfhosted-guide) - Custom IdP integration |
braginini
reviewed
Jan 22, 2026
|
|
||
| - [Self-hosting Quickstart Guide](/selfhosted/selfhosted-quickstart) - Get started quickly with default settings | ||
| - [Advanced Self-hosting Guide](/selfhosted/selfhosted-guide) - Custom IdP integration | ||
| - [Environment Variables](/selfhosted/environment-variables) - Runtime environment configuration |
Contributor
There was a problem hiding this comment.
Suggested change
| - [Environment Variables](/selfhosted/environment-variables) - Runtime environment configuration |
braginini
approved these changes
Jan 22, 2026
shuuri-labs
added a commit
that referenced
this pull request
Jan 22, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added detailed breakdown for all of (self-hoste) NetBird's config files and their values.