authelia/docs/configuration/miscellaneous.md
Clément Michaud c429488738
[FEATURE] [BREAKING] Support writing logs in a file. (#686)
* [FEATURE] Support writing logs in a file.

* Add documentation about logs file path.

* Rename logs_level and logs_file_path into log_level and log_file_path.

* Update BREAKING.md

Fixes #338

Co-authored-by: Amir Zarrinkafsh <nightah@me.com>
2020-03-09 20:57:53 +01:00

77 lines
1.7 KiB
Markdown

---
layout: default
title: Miscellaneous
parent: Configuration
nav_order: 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
## Log
### Log level
`optional: true`
Defines the level of logs used by Authelia. This level can be set to
`trace`, `debug`, `info`.
log_level: debug
### Log file path
`optional: true`
Logs can be stored in a file when file path is provided. Otherwise logs
are written to standard output.
log_file_path: /var/log/authelia.log
## 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.