From d6bea97a9336be8b9541a75df6c3a2fc3ebdea0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Michaud?= Date: Mon, 1 Jun 2020 08:55:58 +0200 Subject: [PATCH] [DOCS] Add a roadmap section to the documentation. (#1062) * [DOCS] Add a roadmap section to the documentation. Adding the roadmap will likely help people figure out what are the next big topics that might be missing for them to take the leap and use Authelia. Maybe some users are also waiting for a feature to unlock some use cases. * Apply suggestions from code review Co-authored-by: James Elliott Co-authored-by: Amir Zarrinkafsh Co-authored-by: James Elliott --- README.md | 2 ++ docs/community/index.md | 2 +- docs/index.md | 2 +- docs/roadmap.md | 37 +++++++++++++++++++++++++++++++++++++ 4 files changed, 41 insertions(+), 2 deletions(-) create mode 100644 docs/roadmap.md diff --git a/README.md b/README.md index 6c1b60b59..a8c1ac4f7 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,8 @@ Here is the list of the main available features: For more details about the features, follow [Features](https://docs.authelia.com/features/). +If you want to know more about the roadmap, follow [Roadmap](https://docs.authelia.com/roadmap). + ## Proxy support Authelia works in combination with [nginx], [Traefik] or [HAProxy]. It can be deployed on bare metal with diff --git a/docs/community/index.md b/docs/community/index.md index b114f41b3..098131866 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -1,7 +1,7 @@ --- layout: default title: Community -nav_order: 9 +nav_order: 10 has_children: true --- diff --git a/docs/index.md b/docs/index.md index d81fbd5ef..f8606080d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -40,7 +40,7 @@ so that you can test it in minutes. Let's begin with the ## However, Authelia... -* is not an OAuth or OpenID Connect provider yet. +* is not an OAuth or OpenID Connect provider yet (planned in the [roadmap](./roadmap.md)) * is not a SAML provider yet. * does not support authentication against an OAuth or OpenID Connect provider yet. * does not support authentication against a SAML provider yet. diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 000000000..d7ac74662 --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,37 @@ +--- +layout: default +title: Roadmap +nav_order: 9 +--- + +# Roadmap + +Currently the team consists of 3 globally distributed developers working actively on improving Authelia in our spare time and we define +our priorities based on a roadmap that we share here for transparency. We also try to balance features and improvements as much as possible with +the maintenance tasks we have to perform to keep the backlog of open issues in a 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. + +Below are the prioritised roadmap items: + +1. [Authelia acts as an OpenID Connect Provider](https://github.com/authelia/authelia/issues/189). This is a high +priority because currently the only way to pass authentication information back to the protected app is through the +use of HTTP headers as described +[here](https://docs.authelia.com/deployment/supported-proxies/#how-can-the-backend-be-aware-of-the-authenticated-users) +however, many apps either do not support this method or are starting to move away from this in favour of OpenID Connect or OAuth2 +internally or via plugins. + +2. [Administration interface](https://github.com/authelia/authelia/issues/974). This is useful in many cases to +properly manage users and administrate activities like unbanning banned users. In the future we can even think of +adding/removing users from there, request a password reset for a user or all users, request a 2FA enrollment, +temporarily block users, etc... + +3. [User interface](https://github.com/authelia/authelia/issues/303). This will help the users manage their 2FA +devices, reset their password, review their authentication activity. +In the future we envisage users will be able to customize their profile with an avatar, set their preferences +regarding 2FA and according to the global policy defined by administrators, etc... + +4. [Facilitate setup on Kubernetes](https://github.com/authelia/authelia/issues/974). There are mainly two objectives +here. First, we need to provide the documentation required to setup Authelia on Kubernetes. Even though, some users +already have it working and the feature is even tested in the project, there is a clear lack of documentation. The +second item is to provide a Helm chart to streamline the setup on Kubernetes.