Skip to content

Commit

Permalink
docs: add description of how to use permission system with external p…
Browse files Browse the repository at this point in the history
…roviders (#194)
  • Loading branch information
CrazyWolf13 authored Feb 3, 2025
1 parent c77918e commit b42a994
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/advanced/single-sign-on/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,11 @@ Homarr supports multiple authentication options, from internal userbase (credent
| ``AUTH_OIDC_GROUPS_ATTRIBUTE`` | Attribute used for groups (roles) claim | groups |
| ``AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE`` | Overwrite name attribute. By default it will use preferred_username if it does not contain a `@` and otherwise name. | --- |

### Permission System

To give a user special permissions, first create a new group in homarr and assign the permission desired.
For example if the group on homarr is called `homarr-admins` a new group on the oidc provider, for example authentik needs to be created with the same name, that would be `homarr-admins`.
After assigning the group on the oidc provider to the user, and logging again into homarr, the user should automatically get placed in that group and inherit the permissions defined.

</TabItem>
</Tabs>

0 comments on commit b42a994

Please sign in to comment.