mirror of
https://github.com/0rangebananaspy/authelia.git
synced 2024-09-14 22:47:21 +07:00
712288555c
* add .crt to the PEM extensions scanned for * fix documentation on the extensions allowed * add trace logging to the loading process to help debug in the future
128 lines
3.4 KiB
Markdown
128 lines
3.4 KiB
Markdown
---
|
|
layout: default
|
|
title: Miscellaneous
|
|
parent: Configuration
|
|
nav_order: 3
|
|
---
|
|
|
|
# Miscellaneous
|
|
|
|
Here are the main customizable options in Authelia.
|
|
|
|
## Host & Port
|
|
|
|
`optional: true`
|
|
|
|
Defines the address and port to listen on.
|
|
|
|
```yaml
|
|
host: 0.0.0.0
|
|
port: 9091
|
|
```
|
|
|
|
Note: If utilising an IPv6 literal address it must be enclosed by square brackets and quoted:
|
|
|
|
```yaml
|
|
host: "[fd00:1111:2222:3333::1]"
|
|
```
|
|
|
|
## TLS
|
|
|
|
`optional: true`
|
|
|
|
Authelia can use TLS. Provide the certificate and the key with the
|
|
following configuration options:
|
|
|
|
```yaml
|
|
tls_key: /config/ssl/key.pem
|
|
tls_cert: /config/ssl/cert.pem
|
|
```
|
|
|
|
## Certificates Directory
|
|
|
|
`optional: true`
|
|
|
|
This option defines the location of additional certificates to load into the trust chain specifically for Authelia.
|
|
This currently affects both the SMTP notifier and the LDAP authentication backend. The certificates should all be in the
|
|
PEM format and end with the extension `.pem`, `.crt`, or `.cer`. You can either add the individual certificates public key
|
|
or the CA public key which signed them (don't add the private key).
|
|
|
|
|
|
## Log
|
|
|
|
### Log level
|
|
|
|
`optional: true`
|
|
|
|
Defines the level of logs used by Authelia. This level can be set to
|
|
`trace`, `debug` or `info`. When setting log_level to `trace`, you will
|
|
generate a large amount of log entries and expose the `/debug/vars` and
|
|
`/debug/pprof/` endpoints which should not be enabled in production.
|
|
|
|
```yaml
|
|
log_level: debug
|
|
```
|
|
|
|
### Log format
|
|
|
|
`optional: true`
|
|
|
|
Defines the format of the logs written by Authelia.
|
|
This format can be set to `json` or `text`.
|
|
|
|
```yaml
|
|
log_format: json
|
|
```
|
|
|
|
#### JSON format
|
|
```
|
|
{"level":"info","msg":"Logging severity set to info","time":"2020-01-01T00:00:00+11:00"}
|
|
{"level":"info","msg":"Authelia is listening for non-TLS connections on 0.0.0.0:9091","time":"2020-01-01T00:00:00+11:00"}
|
|
```
|
|
#### Text format
|
|
```
|
|
time="2020-01-01T00:00:00+11:00" level=info msg="Logging severity set to info"
|
|
time="2020-01-01T00:00:00+11:00" level=info msg="Authelia is listening for non-TLS connections on 0.0.0.0:9091"
|
|
```
|
|
|
|
### Log file path
|
|
|
|
`optional: true`
|
|
|
|
Logs can be stored in a file when file path is provided. Otherwise logs
|
|
are written to standard output. When setting the log_level to `debug` or
|
|
`trace` this will generate large amount of log entries.
|
|
Administrators will need to ensure that they rotate and/or truncate the
|
|
logs over time to prevent significant long-term disk usage.
|
|
|
|
```yaml
|
|
log_file_path: /config/authelia.log
|
|
```
|
|
|
|
## JWT Secret
|
|
|
|
`optional: false`
|
|
|
|
Defines the secret used to craft JWT tokens leveraged by the identity
|
|
verification process. This can also be defined using a [secret](./secrets.md).
|
|
|
|
```yaml
|
|
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.
|