docs: update docs (#4597)
parent
f2b06e180a
commit
859b403146
|
@ -26,6 +26,7 @@ body:
|
||||||
description: What version(s) of Authelia can you reproduce this bug on?
|
description: What version(s) of Authelia can you reproduce this bug on?
|
||||||
multiple: true
|
multiple: true
|
||||||
options:
|
options:
|
||||||
|
- v4.37.4
|
||||||
- v4.37.3
|
- v4.37.3
|
||||||
- v4.37.2
|
- v4.37.2
|
||||||
- v4.37.1
|
- v4.37.1
|
||||||
|
|
|
@ -10,7 +10,9 @@ Don't hesitate to come help us improve Authelia! See you soon!
|
||||||
|
|
||||||
## Bug Reports and Feature Requests
|
## Bug Reports and Feature Requests
|
||||||
|
|
||||||
If you've found a **bug** or have a **feature request** then please create an issue in this repository (but search first in case a similar issue already exists).
|
If you've found a **bug** or have a **feature request** then please create a
|
||||||
|
[bug report](https://www.authelia.com/l/bug) or [feature request](https://www.authelia.com/l/fr) respectively in this
|
||||||
|
repository (but search first in case a similar issue already exists).
|
||||||
|
|
||||||
## Code
|
## Code
|
||||||
|
|
||||||
|
@ -23,13 +25,14 @@ about requirement or implementation. That way you can be sure that the maintaine
|
||||||
and you can hopefully get a quick merge afterwards. Also, let the maintainers know that you plan to work on a particular
|
and you can hopefully get a quick merge afterwards. Also, let the maintainers know that you plan to work on a particular
|
||||||
issue so that no one else starts any duplicate work.
|
issue so that no one else starts any duplicate work.
|
||||||
|
|
||||||
Pull Requests can only be merged once all status checks are green, which means `authelia-scripts --log-level debug ci` passes, and coverage does not regress.
|
Pull Requests can only be merged once all status checks are green, which means `authelia-scripts --log-level debug ci`
|
||||||
|
passes, and coverage does not regress.
|
||||||
|
|
||||||
## Do not force push to your pull request branch
|
## Do not force push to your pull request branch
|
||||||
|
|
||||||
Please do not force push to your PR's branch after you have created your PR, as doing so makes it harder for us to review your work.
|
Please do not force push to your PR's branch after you have created your PR, as doing so makes it harder for us to
|
||||||
PRs will always be squashed by us when we merge your work.
|
review your work. PRs will always be squashed by us when we merge your work. Commit as many times as you need in your
|
||||||
Commit as many times as you need in your pull request branch.
|
pull request branch.
|
||||||
|
|
||||||
## Re-requesting a review
|
## Re-requesting a review
|
||||||
|
|
||||||
|
|
|
@ -209,8 +209,9 @@ Some SMTP servers ignore SMTP specifications and claim to support STARTTLS when
|
||||||
For security reasons Authelia refuses to send messages to these servers.
|
For security reasons Authelia refuses to send messages to these servers.
|
||||||
This option disables this measure and is enabled *__AT YOUR OWN RISK__*. It's *__strongly recommended__*
|
This option disables this measure and is enabled *__AT YOUR OWN RISK__*. It's *__strongly recommended__*
|
||||||
that instead of enabling this option you either fix the issue with the SMTP server's configuration or
|
that instead of enabling this option you either fix the issue with the SMTP server's configuration or
|
||||||
have the administrators of the server fix it. If the issue can't be fixed by configuration we recommend
|
have the administrators of the server fix it. If the issue can't be fixed via the SMTP server configuration we recommend
|
||||||
lodging an issue with the authors of the SMTP server.
|
lodging an issue with the authors of the SMTP server.
|
||||||
|
|
||||||
See [security] for more information.
|
See [security] for more information.
|
||||||
|
|
||||||
### disable_html_emails
|
### disable_html_emails
|
||||||
|
|
|
@ -93,7 +93,7 @@ Reference values.
|
||||||
|
|
||||||
The values this [Claim] has are not strictly defined by the [OpenID Connect] specification. As such, some backends may
|
The values this [Claim] has are not strictly defined by the [OpenID Connect] specification. As such, some backends may
|
||||||
expect a specification other than [RFC8176] for this purpose. If you have such an application and wish for us to support
|
expect a specification other than [RFC8176] for this purpose. If you have such an application and wish for us to support
|
||||||
it then you're encouraged to create an issue.
|
it then you're encouraged to create a [feature request](https://www.authelia.com/l/fr).
|
||||||
|
|
||||||
Below is a list of the potential values we place in the [Claim] and their meaning:
|
Below is a list of the potential values we place in the [Claim] and their meaning:
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
title: "Cache Integrations"
|
title: "Cache Integrations"
|
||||||
description: "A cache integration reference guide"
|
description: "A cache integration reference guide"
|
||||||
lead: "This section contains a cache integration reference guide for Authelia."
|
lead: "This section contains a cache integration reference guide for Authelia."
|
||||||
date: 2022-11-19T16:47:09+11:00
|
date: 2022-12-09T18:24:02+11:00
|
||||||
draft: false
|
draft: false
|
||||||
images: []
|
images: []
|
||||||
menu:
|
menu:
|
||||||
|
|
|
@ -3,6 +3,6 @@
|
||||||
<div class="w-100">
|
<div class="w-100">
|
||||||
This documentation is maintained by the community, it is not guaranteed to be complete or up-to-date.
|
This documentation is maintained by the community, it is not guaranteed to be complete or up-to-date.
|
||||||
We always recommend users read the third-party documentation as part of the integration process to ensure the configuration matches their needs and as such we always link the documentation if available.
|
We always recommend users read the third-party documentation as part of the integration process to ensure the configuration matches their needs and as such we always link the documentation if available.
|
||||||
If you find an error in this documentation please either make a GitHub Pull Request or start a GitHub Discussion.
|
If you find an error in this documentation please either start a <a href="https://github.com/authelia/authelia/discussions">Discussion</a>, make a <a href="https://github.com/authelia/authelia/pulls">Pull Request</a>, or contact us on a <a href="https://www.authelia.com/contact/#chat">Chat Room</a>.
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
Loading…
Reference in New Issue