[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.pull/664/head
parent
3816aa4df2
commit
b5a9e0f047
33
README.md
33
README.md
|
@ -52,9 +52,9 @@ Here is what Authelia's portal looks like
|
||||||
Here is the list of the main available features:
|
Here is the list of the main available features:
|
||||||
|
|
||||||
* Several kind of second factor:
|
* Several kind of second factor:
|
||||||
* **[Security Key (U2F)](./docs/2factor/security-key.md)** with [Yubikey].
|
* **[Security Key (U2F)](https://docs.authelia.com/features/2fa/security-key)** with [Yubikey].
|
||||||
* **[Time-based One-Time password](./docs/2factor/time-based-one-time-password.md)** with [Google Authenticator].
|
* **[Time-based One-Time password](https://docs.authelia.com/features/2fa/one-time-password)** with [Google Authenticator].
|
||||||
* **[Mobile Push Notifications](./docs/2factor/duo-push-notifications.md)** with [Duo](https://duo.com/).
|
* **[Mobile Push Notifications](https://docs.authelia.com/features/2fa/push-notifications)** with [Duo](https://duo.com/).
|
||||||
* Password reset with identity verification using email confirmation.
|
* Password reset with identity verification using email confirmation.
|
||||||
* Single-factor only authentication method available.
|
* Single-factor only authentication method available.
|
||||||
* Access restriction after too many authentication attempts.
|
* 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.
|
* 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.
|
* 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
|
## Proxy support
|
||||||
|
|
||||||
|
@ -84,36 +84,35 @@ You can start off with
|
||||||
git clone https://github.com/authelia/authelia.git && cd authelia
|
git clone https://github.com/authelia/authelia.git && cd authelia
|
||||||
source bootstrap.sh
|
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
|
## Deployment
|
||||||
|
|
||||||
Now that you have tested **Authelia** and you want to try it out in your own infrastructure,
|
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
|
This guide will show you how to deploy it on bare metal as well as on
|
||||||
[Kubernetes](https://kubernetes.io/).
|
[Kubernetes](https://kubernetes.io/).
|
||||||
|
|
||||||
## Security
|
## 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
|
Would you like to report any vulnerability discovered in Authelia, please first contact
|
||||||
**Authelia** and some tips on how to set up **Authelia** in a secure way,
|
**clems4ever** on [Matrix](https://riot.im/app/#/room/#authelia:matrix.org) or by
|
||||||
refer to [Security](./docs/security.md).
|
[email](mailto:clement.michaud34@gmail.com).
|
||||||
|
|
||||||
### Vulnerability report
|
For details about security measures implemented in Authelia, please follow
|
||||||
|
this [link](https://docs.authelia.com/security/measures.html).
|
||||||
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).
|
|
||||||
|
|
||||||
## Breaking changes
|
## Breaking changes
|
||||||
|
|
||||||
See [BREAKING](./BREAKING.md).
|
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
|
## Sponsorship
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Second Factor
|
title: Second Factor
|
||||||
parent: Features
|
parent: Features
|
||||||
nav_order: 1
|
nav_order: 2
|
||||||
has_children: true
|
has_children: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -6,3 +6,10 @@ has_children: true
|
||||||
---
|
---
|
||||||
|
|
||||||
# Security
|
# 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).
|
||||||
|
|
|
@ -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).
|
|
Loading…
Reference in New Issue