diff options
| author | James Elliott <james-d-elliott@users.noreply.github.com> | 2024-03-21 18:57:44 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-21 18:57:44 +1100 |
| commit | 258c536dfdd2ef6b7db2ba7b7c742c110a1388ef (patch) | |
| tree | 410da0e93f28762bc5658bae484a2eba225104da | |
| parent | fdff2bd4514d49df49ec03ffc591f72b1ef24034 (diff) | |
docs: misc improvements (#6988)
Signed-off-by: James Elliott <james-d-elliott@users.noreply.github.com>
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | docs/content/roadmap/active/dashboard-control-panel-and-cli-for-admins.md | 30 | ||||
| -rw-r--r-- | docs/content/roadmap/active/openid-connect.md | 14 | ||||
| -rw-r--r-- | docs/content/roadmap/active/webauthn.md | 9 | ||||
| -rw-r--r-- | docs/content/roadmap/prologue/introduction.md | 6 |
5 files changed, 45 insertions, 18 deletions
@@ -72,7 +72,7 @@ This is a list of the key features of Authelia: * Compatible with [Traefik](https://doc.traefik.io/traefik) out of the box using the [ForwardAuth](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) middleware. * Curated configuration from [LinuxServer](https://www.linuxserver.io/) via their - [Swag](https://docs.linuxserver.io/general/swag) container as well as a + [SWAG](https://docs.linuxserver.io/general/swag) container as well as a [guide](https://blog.linuxserver.io/2020/08/26/setting-up-authelia/). * Compatible with [Caddy] using the [forward_auth](https://caddyserver.com/docs/caddyfile/directives/forward_auth) directive. @@ -83,7 +83,7 @@ This is a list of the key features of Authelia: * [Traefik Kubernetes Ingress](https://www.authelia.com/integration/kubernetes/traefik-ingress/#ingress) * [Istio](https://www.authelia.com/integration/kubernetes/istio/) * Beta support for installing via Helm using our [Charts](https://charts.authelia.com). -* Beta support for [OpenID Connect](https://www.authelia.com/roadmap/active/openid-connect/). +* Beta support for [OAuth 2.0 and OpenID Connect 1.0](https://www.authelia.com/roadmap/active/openid-connect/). For more details take a look at the [Overview](https://www.authelia.com/overview/prologue/introduction/). diff --git a/docs/content/roadmap/active/dashboard-control-panel-and-cli-for-admins.md b/docs/content/roadmap/active/dashboard-control-panel-and-cli-for-admins.md index 936d80adf..676f00155 100644 --- a/docs/content/roadmap/active/dashboard-control-panel-and-cli-for-admins.md +++ b/docs/content/roadmap/active/dashboard-control-panel-and-cli-for-admins.md @@ -99,38 +99,46 @@ due to how important or difficult to implement they are. ### Design Stage -{{< roadmap-status >}} +{{< roadmap-status stage="in-progress" >}} Decide on a design. ### Initial Implementation -{{< roadmap-status >}} +{{< roadmap-status version="v4.40.0" >}} Implement the pivotal elements of the design. ### Design Element: Segregation -{{< roadmap-status >}} +{{< roadmap-status version="v4.40.0" >}} Allow the admin UI to be run as a separate process, on a different port, and at a different URL to Authelia itself. Alternatively allow it to run as part of the main process and port for minimal configurations. -### User Management +### Session Management -{{< roadmap-status >}} +{{< roadmap-status version="v4.40.0" >}} -Manage user accounts with either the internal or LDAP authentication backends. Allow for creation, modification, and -deletion. +Manage user sessions for all users. -### Session Management +### OpenID Connect 1.0 Client Management + +{{< roadmap-status version="v4.40.0" >}} + +Manage client registrations via a web frontend. + +### Access Control Management {{< roadmap-status >}} -Manage user sessions for all users. +Manage Access Control rules. -### OpenID Connect 1.0 Client Management +### User Management {{< roadmap-status >}} -Manage client registrations via a web frontend. +Manage user accounts with either the internal or LDAP authentication backends. Allow for creation, modification, and +deletion. + + diff --git a/docs/content/roadmap/active/openid-connect.md b/docs/content/roadmap/active/openid-connect.md index 116b5effb..30a51049e 100644 --- a/docs/content/roadmap/active/openid-connect.md +++ b/docs/content/roadmap/active/openid-connect.md @@ -20,9 +20,11 @@ seo: noindex: false # false (default) or true --- -We have decided to implement [OpenID Connect 1.0] as a beta feature, it's suggested you only utilize it for testing and -providing feedback, and should take caution in relying on it in production as of now. [OpenID Connect 1.0] and it's -related endpoints are not enabled by default unless you specifically configure the [OpenID Connect 1.0] section. +We have decided to implement [OAuth 2.0] and [OpenID Connect 1.0] as a beta feature. While it's relatively stable there +may inevitably be the occasional breaking change as we carefully implement each aspect of the relevant specifications. +It's suggested to use a bit more caution with this feature than most features, we do however greatly appreciate your +feedback. [OpenID Connect 1.0] and it's related endpoints are not enabled by default unless you explicitly configure the +[OpenID Connect 1.0 Provider Configuration] and [OpenID Connect 1.0 Registered Clients] sections. As [OpenID Connect 1.0] is fairly complex (the [OpenID Connect 1.0] Provider role especially so) it's intentional that it is both a beta and that the implemented features are part of a thoughtful roadmap. Items that are not immediately @@ -144,7 +146,7 @@ Feature List: ### Beta 7 -{{< roadmap-status >}} +{{< roadmap-status version="v4.39.0" >}} Feature List: @@ -253,6 +255,10 @@ The `preferred_username` claim was missing and was fixed. [RFC8693 Section 4.3]: https://datatracker.ietf.org/doc/html/rfc8693/#section-4.3 [RFC4122]: https://datatracker.ietf.org/doc/html/rfc4122 +[OpenID Connect 1.0 Provider Configuration]: ../../configuration/identity-providers/openid-connect/provider.md +[OpenID Connect 1.0 Registered Clients]: ../../configuration/identity-providers/openid-connect/clients.md + +[OAuth 2.0]: https://oauth.net/2/ [OpenID Connect 1.0]: https://openid.net/connect/ [OpenID Connect Dynamic Client Registration 1.0]: https://openid.net/specs/openid-connect-registration-1_0.html [OpenID Connect Session Management 1.0]: https://openid.net/specs/openid-connect-session-1_0.html diff --git a/docs/content/roadmap/active/webauthn.md b/docs/content/roadmap/active/webauthn.md index a70c08ab1..1d41938cb 100644 --- a/docs/content/roadmap/active/webauthn.md +++ b/docs/content/roadmap/active/webauthn.md @@ -53,12 +53,19 @@ the backend, it's just the public facing interface elements remaining. ### Platform Authenticator -{{< roadmap-status >}} +{{< roadmap-status version="v4.39.0" >}} Implement [WebAuthn] Platform Authenticators so that people can use things like [Windows Hello], [TouchID], [FaceID], or [Android Security Key]. This would also allow configuration of the [Authenticator Attachment] setting most likely, or at least allow admins to configure which ones are available for registration. +### Passkeys + +{{< roadmap-status version="v4.39.0" >}} + +Implement the ability to add Passkeys to later be used with [Passwordless Login](#passwordless-login) but immediately as +a 2FA credential. + ### Passwordless Login {{< roadmap-status >}} diff --git a/docs/content/roadmap/prologue/introduction.md b/docs/content/roadmap/prologue/introduction.md index 68944085d..5e61fb619 100644 --- a/docs/content/roadmap/prologue/introduction.md +++ b/docs/content/roadmap/prologue/introduction.md @@ -25,6 +25,12 @@ improvements as much as possible with the maintenance tasks we have to perform t reasonable state. If you're willing to contribute and help us move forward faster, get in touch with us on Matrix. We'll be glad to share ideas and plans with you. +{{< callout context="danger" title="Important Notes" icon="alert-octagon" >}} +It's important to note that the versions listed on a roadmap item unless noted as completed are an intended estimation. +Plans may change and we may potentially forget to update the version. If you feel we've forgotten please feel free to +let us know via a GitHub Discussion or one of the Chat options. +{{< /callout >}} + ## Summary This is a summary of the features which are currently on the roadmap with links to further details: |
