From b5a9e0f0470c229882e3a8bb33478c85b6e40442 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Michaud?= Date: Sun, 1 Mar 2020 00:27:23 +0100 Subject: [PATCH] [DOCS] Update links in README to reference docs.authelia.com. (#667) * [DOCS] Update links in README to reference docs.authelia.com. * Move report section of security to the top level page. * Fix ordering of sub-pages of 2FA feature. --- README.md | 33 ++++++++++++++++----------------- docs/features/2fa/index.md | 2 +- docs/security/index.md | 9 ++++++++- docs/security/report.md | 15 --------------- 4 files changed, 25 insertions(+), 34 deletions(-) delete mode 100644 docs/security/report.md diff --git a/README.md b/README.md index af0c0b707..c0b166863 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,9 @@ Here is what Authelia's portal looks like Here is the list of the main available features: * Several kind of second factor: - * **[Security Key (U2F)](./docs/2factor/security-key.md)** with [Yubikey]. - * **[Time-based One-Time password](./docs/2factor/time-based-one-time-password.md)** with [Google Authenticator]. - * **[Mobile Push Notifications](./docs/2factor/duo-push-notifications.md)** with [Duo](https://duo.com/). + * **[Security Key (U2F)](https://docs.authelia.com/features/2fa/security-key)** with [Yubikey]. + * **[Time-based One-Time password](https://docs.authelia.com/features/2fa/one-time-password)** with [Google Authenticator]. + * **[Mobile Push Notifications](https://docs.authelia.com/features/2fa/push-notifications)** with [Duo](https://duo.com/). * Password reset with identity verification using email confirmation. * Single-factor only authentication method available. * Access restriction after too many authentication attempts. @@ -63,7 +63,7 @@ Here is the list of the main available features: * Highly available using a remote database and Redis as a highly available KV store. * Compatible with Kubernetes [ingress-nginx](https://github.com/kubernetes/ingress-nginx) controller out of the box. -For more details about the features, follow [Features](./docs/features.md). +For more details about the features, follow [Features](https://docs.authelia.com/features/). ## Proxy support @@ -84,36 +84,35 @@ You can start off with git clone https://github.com/authelia/authelia.git && cd authelia source bootstrap.sh -If you want to go further, please read [Getting Started](./docs/getting-started.md). +If you want to go further, please read [Getting Started](https://docs.authelia.com/getting-started). ## Deployment Now that you have tested **Authelia** and you want to try it out in your own infrastructure, -you can learn how to deploy and use it with [Deployment](./docs/deployment-production.md). +you can learn how to deploy and use it with [Deployment](https://docs.authelia.com/deployment/deployment-ha). This guide will show you how to deploy it on bare metal as well as on [Kubernetes](https://kubernetes.io/). ## Security -### Security measures +Security is taken very seriously here, therefore we follow the rule of responsible +disclosure and we encourage you to do so. -If you want more information about the security measures applied by -**Authelia** and some tips on how to set up **Authelia** in a secure way, -refer to [Security](./docs/security.md). +Would you like to report any vulnerability discovered in Authelia, please first contact +**clems4ever** on [Matrix](https://riot.im/app/#/room/#authelia:matrix.org) or by +[email](mailto:clement.michaud34@gmail.com). -### Vulnerability report - -Security is taken very seriously here, therefore we follow the rule of responsible disclosure and we encourage you to do so. - -Would you like to report any vulnerability discovered in Authelia, please first contact **clems4ever** on [Matrix](https://riot.im/app/#/room/#authelia:matrix.org) or by [email](mailto:clement.michaud34@gmail.com). +For details about security measures implemented in Authelia, please follow +this [link](https://docs.authelia.com/security/measures.html). ## Breaking changes See [BREAKING](./BREAKING.md). -## Build Authelia +## Contribute -If you want to contribute with code, you should follow the documentation explaining how to [build](./docs/build-and-dev.md) the application. +If you want to contribute to Authelia, check the documentation available +[here](https://docs.authelia.com/contributing/). ## Sponsorship diff --git a/docs/features/2fa/index.md b/docs/features/2fa/index.md index f8a820f06..d6d92a7af 100644 --- a/docs/features/2fa/index.md +++ b/docs/features/2fa/index.md @@ -2,7 +2,7 @@ layout: default title: Second Factor parent: Features -nav_order: 1 +nav_order: 2 has_children: true --- diff --git a/docs/security/index.md b/docs/security/index.md index 48671620d..d051bf0e1 100644 --- a/docs/security/index.md +++ b/docs/security/index.md @@ -5,4 +5,11 @@ nav_order: 6 has_children: true --- -# Security \ No newline at end of file +# Security + +Security is taken very seriously here, therefore we follow the rule of +responsible disclosure and we encourage you to do so. + +Would you like to report any vulnerability discovered in Authelia, please +first contact **clems4ever** on [Matrix](https://riot.im/app/#/room/#authelia:matrix.org) +or by [email](mailto:clement.michaud34@gmail.com). diff --git a/docs/security/report.md b/docs/security/report.md deleted file mode 100644 index 299bf4c02..000000000 --- a/docs/security/report.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: default -title: Report Vulnerabilities -parent: Security -nav_order: 1 ---- - -# Report Vulnerabilities - -Security is taken very seriously here, therefore we follow the rule of -responsible disclosure and we encourage you to do so. - -Would you like to report any vulnerability discovered in Authelia, please -first contact **clems4ever** on [Matrix](https://riot.im/app/#/room/#authelia:matrix.org) -or by [email](mailto:clement.michaud34@gmail.com).