SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-05-14 04:01:55 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

Allow netbirdio/management to startup without SSO .wellknown or cache it #1034

New Issue
Open
opened 2025-11-20 05:22:43 -05:00 by saavagebueno · 2 comments
saavagebueno commented 2025-11-20 05:22:43 -05:00
Owner
Copy Link

Originally created by @ykorzikowski on GitHub (Jul 1, 2024).

Is your feature request related to a problem? Please describe.
Whenever SSO like Authentik, Keycloak is not available, the management service won't start.

2024-07-01T15:26:10Z INFO management/cmd/management.go:455: loading OIDC configuration from the provided IDP configuration endpoint https://sso.***.***/realms/master/.well-known/openid-configuration
Error: failed reading provided config file: /etc/netbird/management.json: failed fetching OIDC configuration from endpoint https://sso.***.***/realms/master/.well-known/openid-configuration Get "https://sso.***.***/realms/master/.well-known/openid-configuration": dial tcp 95.***.***.***:443: i/o timeout

This may not be an issue in big, HA environments, but if you use netbird also for inter-server-communication, you may create a circular dependency (netbird needs sso which needs reverse proxy which needs netbird to connect to keycloak).

Describe the solution you'd like
Add an option the service start in a fail safe mode or provide an option to cache this file and use it instead until the server is online again.

Describe alternatives you've considered

Additional context

  • After 6h of management-service being offline, my netbird clients will drop the connection and wont work until its up again.
Originally created by @ykorzikowski on GitHub (Jul 1, 2024). **Is your feature request related to a problem? Please describe.** Whenever SSO like Authentik, Keycloak is not available, the management service won't start. ``` 2024-07-01T15:26:10Z INFO management/cmd/management.go:455: loading OIDC configuration from the provided IDP configuration endpoint https://sso.***.***/realms/master/.well-known/openid-configuration Error: failed reading provided config file: /etc/netbird/management.json: failed fetching OIDC configuration from endpoint https://sso.***.***/realms/master/.well-known/openid-configuration Get "https://sso.***.***/realms/master/.well-known/openid-configuration": dial tcp 95.***.***.***:443: i/o timeout ``` This may not be an issue in big, HA environments, but if you use netbird also for inter-server-communication, you may create a circular dependency (netbird needs sso which needs reverse proxy which needs netbird to connect to keycloak). **Describe the solution you'd like** Add an option the service start in a fail safe mode or provide an option to cache this file and use it instead until the server is online again. **Describe alternatives you've considered** **Additional context** - After 6h of management-service being offline, my netbird clients will drop the connection and wont work until its up again.
saavagebueno added the feature-request label 2025-11-20 05:22:43 -05:00
saavagebueno commented 2025-11-20 05:22:43 -05:00
Author
Owner
Copy Link

@mlsmaycon commented on GitHub (Jul 1, 2024):

@ykorzikowski, did all clients lose all connections with other peers after you had this issue with management? Can you share your client logs, too? If this is happening, it looks like there is a problem with the client's retry.

Regarding the configuration endpoint, it is not a hard requirement. It was used when you first ran the configure.sh script, and it added most of the fields that get overwritten by the management service. You can remove it from management.json and restart the management service to validate.

@mlsmaycon commented on GitHub (Jul 1, 2024): @ykorzikowski, did all clients lose all connections with other peers after you had this issue with management? Can you share your client logs, too? If this is happening, it looks like there is a problem with the client's retry. Regarding the configuration endpoint, it is not a hard requirement. It was used when you first ran the configure.sh script, and it added most of the fields that get overwritten by the management service. You can remove it from management.json and restart the management service to validate.
saavagebueno commented 2025-11-20 05:22:44 -05:00
Author
Owner
Copy Link

@ykorzikowski commented on GitHub (Jul 2, 2024):

Hi @mlsmaycon , this time, I only notice my macbook lost the connection. The other clients seems to keep the connection.

What exactly do you mean by "removing it"?

[...]
    "HttpConfig": {
        "LetsEncryptDomain": "",
        "CertFile": "",
        "CertKey": "",
        "AuthAudience": "netbird-client",
        "AuthIssuer": "https://sso.***.com/realms/master",
        "AuthUserIDClaim": "",
        "AuthKeysLocation": "https://sso.***.com/realms/master/protocol/openid-connect/certs",
        "OIDCConfigEndpoint": "https://sso.***.com/realms/master/.well-known/openid-configuration",
        "IdpSignKeyRefreshEnabled": false
    },
    "IdpManagerConfig": {
        "ManagerType": "keycloak",
        "ClientConfig": null,
        "ExtraConfig": null,
        "Auth0ClientCredentials": null,
        "AzureClientCredentials": null,
        "KeycloakClientCredentials": {
            "ClientID": "***",
            "ClientSecret": "***",
            "AdminEndpoint": "https://sso.***.com/admin/realms/master",
            "TokenEndpoint": "https://sso.***.com/realms/master/protocol/openid-connect/token",
            "GrantType": "client_credentials"
        },
        "ZitadelClientCredentials": null
    },
[...]
@ykorzikowski commented on GitHub (Jul 2, 2024): Hi @mlsmaycon , this time, I only notice my macbook lost the connection. The other clients seems to keep the connection. What exactly do you mean by "removing it"? ``` [...] "HttpConfig": { "LetsEncryptDomain": "", "CertFile": "", "CertKey": "", "AuthAudience": "netbird-client", "AuthIssuer": "https://sso.***.com/realms/master", "AuthUserIDClaim": "", "AuthKeysLocation": "https://sso.***.com/realms/master/protocol/openid-connect/certs", "OIDCConfigEndpoint": "https://sso.***.com/realms/master/.well-known/openid-configuration", "IdpSignKeyRefreshEnabled": false }, "IdpManagerConfig": { "ManagerType": "keycloak", "ClientConfig": null, "ExtraConfig": null, "Auth0ClientCredentials": null, "AzureClientCredentials": null, "KeycloakClientCredentials": { "ClientID": "***", "ClientSecret": "***", "AdminEndpoint": "https://sso.***.com/admin/realms/master", "TokenEndpoint": "https://sso.***.com/realms/master/protocol/openid-connect/token", "GrantType": "client_credentials" }, "ZitadelClientCredentials": null }, [...] ```
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label feature-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#1034
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?