SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-07-30 09:53:19 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

Keycloak Invalid RealmID #640

New Issue
Open
opened 2025-11-20 05:15:07 -05:00 by saavagebueno · 1 comment
saavagebueno commented 2025-11-20 05:15:07 -05:00
Owner
Copy Link

Originally created by @JonnyBDev on GitHub (Feb 15, 2024).

Describe the problem
We had some trouble setting up Netbird with Keycloak. After some testing we've found out that a RealmID with a space in it will result in Netbird not being able to "warm up cache" and not running as expected at all.

We did not use the RealmID "netbird" as suggested in the docs because our users are stored in the company default Realm "Company GmbH". This will result in an escaped url which looked like this for the admin endpoint:
https://id.customerdomain.tld/admin/realms/company%20gmbh

As I said using this RealmID, we couldn't get Netbird running. Connecting to the UI worked, but it showed a 401 token invalid error message. After renaming the RealmID from "Company GmbH" to "companygmbh", without changing any credentials only the urls, it worked.

To Reproduce

Steps to reproduce the behavior:
Follow the advanced Guide to setup a selfhosted instance with Keycloak.

Expected behavior

Netbird should work with all kinds of RealmIDs

NetBird version
0.25.5

Originally created by @JonnyBDev on GitHub (Feb 15, 2024). **Describe the problem** We had some trouble setting up Netbird with Keycloak. After some testing we've found out that a RealmID with a space in it will result in Netbird not being able to "warm up cache" and not running as expected at all. We did not use the RealmID "netbird" as suggested in the docs because our users are stored in the company default Realm "Company GmbH". This will result in an escaped url which looked like this for the admin endpoint: `https://id.customerdomain.tld/admin/realms/company%20gmbh` As I said using this RealmID, we couldn't get Netbird running. Connecting to the UI worked, but it showed a 401 token invalid error message. After renaming the RealmID from "Company GmbH" to "companygmbh", without changing any credentials only the urls, it worked. **To Reproduce** Steps to reproduce the behavior: Follow the advanced Guide to setup a selfhosted instance with Keycloak. **Expected behavior** Netbird should work with all kinds of RealmIDs **NetBird version** 0.25.5
saavagebueno added the bugtriage-neededkeycloakself-hosting labels 2025-11-20 05:15:08 -05:00
saavagebueno commented 2025-11-20 05:15:08 -05:00
Author
Owner
Copy Link

@surik commented on GitHub (Feb 15, 2024):

Hi @JonnyBDev, we just made a short validation with Keycloak 23. It doesn't allow us to have any special characters in the realm name. See screenshot.

Can you give a bit more information about your setup? Some things that may help:

  1. Keycloack version
  2. Was the realm created on some older version
  3. What do you see if you go to the realm setting and check the URL shown in the browser, eg: http://localhost:8080/admin/master/console/#/test1/realm-settings. Where test1 is the realm name/id.
image
@surik commented on GitHub (Feb 15, 2024): Hi @JonnyBDev, we just made a short validation with Keycloak 23. It doesn't allow us to have any special characters in the realm name. See screenshot. Can you give a bit more information about your setup? Some things that may help: 1. Keycloack version 2. Was the realm created on some older version 3. What do you see if you go to the realm setting and check the URL shown in the browser, eg: `http://localhost:8080/admin/master/console/#/test1/realm-settings`. Where `test1` is the realm name/id. <img width="1208" alt="image" src="https://github.com/netbirdio/netbird/assets/708165/1189debf-437b-423f-9f15-3db0ef1b0754">
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 bug keycloak self-hosting triage-needed
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#640
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?