authelia/docs/configuration/miscellaneous.md
Clément Michaud faf43de14f
[FEATURE] Add TLS support. (#677)
* [FEATURE] Add TLS support.

Fixes #368.

* [FEATURE] Introduce OnError hook in suites.

This hook allows to perform actions following an erroneous suite
like displaying the logs of Authelia.

* Display Authelia logs of Standalone suite when tests fail.

* Fix Standalone suite.

* Apply suggestions from code review

* Rename ssl_key and ssl_cert into tls_key and tls_cert.
2020-03-03 18:18:25 +11:00

1.5 KiB

layout title parent nav_order
default Miscellaneous Configuration 5

Miscellaneous

Here are the main customizable options in Authelia.

Host & Port

optional: true

Defines the address to listen on.

host: 0.0.0.0
port: 9091

TLS

optional: true

Authelia can use TLS. Provide the certificate and the key with the following configuration options:

tls_key: /var/lib/authelia/ssl/key.pem
tls_cert: /var/lib/authelia/ssl/cert.pem

Logs level

optional: true

Defines the level of logs used by Authelia. This level can be set to trace, debug, info.

logs_level: debug

JWT Secret

optional: false

Defines the secret used to craft JWT tokens leveraged by the identity verification process

jwt_secret: v3ry_important_s3cr3t

Default redirection URL

optional: true

The default redirection URL is the URL where users are redirected when Authelia cannot detect the target URL where the user was heading.

In a normal authentication workflow, a user tries to access a website and she gets redirected to the sign-in portal in order to authenticate. Since the user initially targeted a website, the portal knows where the user was heading and can redirect her after the authentication process. However, when a user visits the sign in portal directly, the portal considers the targeted website is the portal. In that case and if the default redirection URL is configured, the user is redirected to that URL. If not defined, the user is not redirected after authentication.