Skip to content

Improving Netbird documentation #14156

@NJMonnet

Description

@NJMonnet

Do you see an area that can be clarified or expanded, a technical inaccuracy, or a broken link? Please describe.
Hi, after struggling for 1 week and trying lots of things, I think the Netbird integration documentation needs to be improved.

The problem with the documentation is that there are already two of them, which creates a lot of confusion when it comes to setting them up. See :
https://docs.goauthentik.io/integrations/services/netbird/
https://docs.netbird.io/selfhosted/identity-providers#authentik

Provide the URL or link to the exact page in the documentation to which you are referring.
https://docs.goauthentik.io/integrations/services/netbird/

Describe the solution you'd like

  1. In my opinion, the authentik documentation should be based on the Netbird documentation, as it is functional. This will reduce the number of different configurations and make troubleshooting easier.
    The major differences :
    The change of client between ‘Public’ and ‘Confidential’.
    Creation of a new authentication flow.

  2. Something that is not included in either of the two (I don't know if this is normal), the addition of ‘Available Scopes’ -> ‘authentik API access’. This is necessary otherwise there will be a 401 error in the management, see -> Request failed with status code 401 (Authentik) netbirdio/netbird#2941 (comment)

  3. It would be a good idea to add a Troubleshooting category, despite my many attempts, certain problems seem to occur regardless of the configuration. As long as Netbird hasn't fixed this, it could help users who still want to implement it.

The main problem is that in setup.env, at least with traefik, without the :
NETBIRD_MGMT_API_PORT=443
NETBIRD_SIGNAL_PORT=443
The /peers will load in a loop, preventing login.
-> netbirdio/netbird#3007

  1. If the user creates an access group for the Netbird application, the Netbird service account must be included in the group, at the risk of getting a 401 error after login.

Additional context
I've tried to do as many tests as possible, but it's still possible that these problems are due to my configuration and I apologise if this is the case.

I might try to submit a pull request myself but I don't have much time.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions