diff --git a/charts/enterprise/authelia/docs/authelia-rules.md b/charts/enterprise/authelia/docs/authelia-rules.md new file mode 100644 index 00000000000..bbd529d58b6 --- /dev/null +++ b/charts/enterprise/authelia/docs/authelia-rules.md @@ -0,0 +1,107 @@ +# Authelia Rules + +This is a collection of some common Authelia Rules. + +:::note[RULE ORDER] + +It is important that rules are created in the correct order in Authelia. Rules are processed from top to bottom with the first matching rule being applied. The most narrow rules should be applied first with the most broad rules last. + +::: + +All rules requiring Authelia authentication were configured with `two_factor` (2FA). If you do not want 2FA on some or all rules replace the Policy with `one_factor` + +## API Rule + +This rule will bypass Authelia for API level access in most apps. This should always be your first rule. + +Domain: `*.domain.tld` + +Policy: `bypass` + +Subject: `Not Used (Do Not Add)` + +Networks: `Not Used (Do Not Add)` + +Resources: + +- `^/api([/?].*)?$` +- `^/identity.*$` +- `^/triggers.*$` +- `^/meshagents.*$` +- `^/meshsettings.*$` +- `^/agent.*$` +- `^/control.*$` +- `^/meshrelay.*$` +- `^/wl.*$` + +![authelia-api](./img/authelia-api.png) + +## Vaultwarden + +These rules will protect the Vaultwarden admin page with Authelia but bypass when accessing the web vault. The order of these rules is critical or the admin page will not be protected. + +### Rule 1 + +Domain: `vaultwarden.domain.tld` + +Policy: `two_factor` + +Subject: `Not Used (Do Not Add)` + +Networks: `Not Used (Do Not Add)` + +Resources: `^*/admin.*$` + +![authelia-vw1](./img/authelia-vw1.png) + +### Rule 2 + +Domain: `vaultwarden.domain.tld` + +Policy: `bypass` + +Subject: `Not Used (Do Not Add)` + +Networks: `Not Used (Do Not Add)` + +Resources: `Not Used (Do Not Add)` + +![authelia-vw2](./img/authelia-vw2.png) + +## User Rule + +This rule will allow users in the `lldap_user` group access to only the specified applications. + +Domain: + +- `radarr.domain.tld` +- `sonarr.domain.tld` + +Policy: `two_factor` + +Subject: `group:lldap_user` + +Networks: `Not Used (Do Not Add)` + +Resources: `Not Used (Do Not Add)` + +![authelia-user](./img/authelia-user.png) + +## Catch All Rule + +This rule will catch any access requests not covered by other rules. + +Domain: + +- `domain.tld` +- `*.domain.tld` + +Policy: `two_factor` + +Subject: `group:lldap_admin` + +Networks: `Not Used (Do Not Add)` + +Resources: `Not Used (Do Not Add)` + +![authelia-catch](./img/authelia-catch.png) diff --git a/charts/enterprise/authelia/docs/img/authelia-api.png b/charts/enterprise/authelia/docs/img/authelia-api.png new file mode 100644 index 00000000000..4d3da5d237f Binary files /dev/null and b/charts/enterprise/authelia/docs/img/authelia-api.png differ diff --git a/charts/enterprise/authelia/docs/img/authelia-catch.png b/charts/enterprise/authelia/docs/img/authelia-catch.png new file mode 100644 index 00000000000..c84f9e315e2 Binary files /dev/null and b/charts/enterprise/authelia/docs/img/authelia-catch.png differ diff --git a/charts/enterprise/authelia/docs/img/authelia-user.png b/charts/enterprise/authelia/docs/img/authelia-user.png new file mode 100644 index 00000000000..ea43abc855e Binary files /dev/null and b/charts/enterprise/authelia/docs/img/authelia-user.png differ diff --git a/charts/enterprise/authelia/docs/img/authelia-vw1.png b/charts/enterprise/authelia/docs/img/authelia-vw1.png new file mode 100644 index 00000000000..ba35026229e Binary files /dev/null and b/charts/enterprise/authelia/docs/img/authelia-vw1.png differ diff --git a/charts/enterprise/authelia/docs/img/authelia-vw2.png b/charts/enterprise/authelia/docs/img/authelia-vw2.png new file mode 100644 index 00000000000..0f99b305237 Binary files /dev/null and b/charts/enterprise/authelia/docs/img/authelia-vw2.png differ