11# Netbird Installation
22
3- This document outlines the steps to customize the Helm installation for Coturn and Netbird services .
4- This installation comes up KeyCloak auth integration.
5- The modifications include changing the Coturn service type and setting up ingress for all Netbird services.
3+ This Helm chart is for self hosting [ Netbird] ( https://netbird.io ) .
4+
5+ This document outlines the steps to customize the Helm installation for Coturn and Netbird services with KeyCloak IdP .
66
77Refer the example [ values.yaml] ( ./examples/values.yaml ) for additional configurations.
8- You can simply copy-paste the values file in your kubeaid-config, and replace the necessary values to get netbird working.
8+ You can simply copy-paste the values file in your kubeaid-config, and replace the necessary values to get Netbird working.
99
1010## Modify Coturn Service Configuration
1111
@@ -26,7 +26,7 @@ This will use gRPC protocol.
2626netbird :
2727 <service-name> :
2828 service :
29- port : 80
29+ port : <service-port>
3030 ingress :
3131 enabled : true
3232 annotations :
@@ -105,11 +105,36 @@ Relays:
105105 [rels://vpn.example.com:443/relay] is Available
106106Nameservers:
107107FQDN: viljkid.netbird.selfhosted
108- NetBird IP: 100.94.110.131/16
108+ NetBird IP: < sensitive >
109109Interface type: Kernel
110110Quantum resistance: false
111111Lazy connection: false
112112Networks: 10.96.0.0/16
113113Forwarding rules: 0
114114Peers count: 1/2 Connected
115115```
116+
117+ ## Troubleshooting
118+
119+ ### GET /api/users status 401
120+
121+ Netbird caches the Keycloak users locally. If it is not able to fetch the users from Keycloak, it throws an error with
122+
123+ ``` log
124+ unable to get keycloak token, statusCode 401
125+ ```
126+
127+ ** Solution:**
128+
129+ - Set the log level to Debug for the netbird-management pod with ` --log-level=debug ` as the container arg
130+ - Check the pod logs about token not found
131+ - Check if the service account ` netbird-backend ` has the permission to ` view-users ` in Keycloak
132+ - Check if the ` AdminEndpoint ` in the IdPManagerConfig is correct ` https://keycloak.example.com/auth/admin/realms/netbird `
133+
134+ Once this is correct, Netbird pod should be able to warm up the cache and fetch user IDs.
135+
136+ ## References and External Links
137+
138+ - https://docs.netbird.io/about-netbird/how-netbird-works
139+ - https://docs.netbird.io/selfhosted/identity-providers#keycloak
140+ - https://docs.netbird.io/selfhosted/troubleshooting
0 commit comments