Configuration.yml: Difference between revisions

From FlowerHouseWiki
No edit summary
No edit summary
Line 1: Line 1:
<syntaxhighlight lang="yaml" line>
<syntaxhighlight lang="yaml" line>
# yamllint disable rule:comments-indentation
###############################################################################  
---
###############################################################################
#                          Authelia Configuration                            #
#                          Authelia Configuration                            #
###############################################################################
###############################################################################


## The host and port to listen on.
## The host and port to listen on.
host: 0.0.0.0
server.host: 0.0.0.0
port: 9091
server.port: 9091
 
## The TLS key and cert used with Authelia.
# tls_key: /config/ssl/key.pem
# tls_cert: /config/ssl/cert.pem
 
## Certificates directory specifies where Authelia will load trusted certificates (public portion) from in addition to
## the system certificates store.
## They should be in base64 format, and have one of the following extensions: *.cer, *.crt, *.pem.
# certificates_directory: /config/certificates


## The theme to display: light, dark, grey.
## The theme to display: light, dark, grey.
theme: light
theme: light


##
## Server Configuration
## Server Configuration
##
server:
server:
   ## Buffers usually should be configured to be the same value.
   ## Buffers usually should be configured to be the same value.
   ## Explanation at https://www.authelia.com/docs/configuration/server.html
   ## Explanation at https://www.authelia.com/docs/configuration/server.html
  ## Read buffer size adjusts the server's max incoming request size in bytes.
  ## Write buffer size does the same for outgoing responses.
   read_buffer_size: 4096
   read_buffer_size: 4096
   write_buffer_size: 4096
   write_buffer_size: 4096
Line 37: Line 22:


## Level of verbosity for logs: info, debug, trace.
## Level of verbosity for logs: info, debug, trace.
log_level: debug
log.level: debug


## Format the logs are written as: json, text.
## Format the logs are written as: json, text.
log_format: text
log.format: text


## File path where the logs will be written. If not set logs are written to stdout.
## File path where the logs will be written. If not set logs are written to stdout.
log_file_path: /etc/authelia/authelia.log
log.file_path: /etc/authelia/authelia.log


## The secret used to generate JWT tokens when validating user identity by email confirmation. JWT Secret can also be
## The secret used to generate JWT tokens when validating user identity by email confirmation. JWT Secret can also be
## set using a secret: https://www.authelia.com/docs/configuration/secrets.html
## set using a secret: https://www.authelia.com/docs/configuration/secrets.html
jwt_secret: random_password_string
jwt_secret: MY_PASSWORD


## Default redirection URL
## Default redirection URL
##
## If user tries to authenticate without any referer, Authelia does not know where to redirect the user to at the end
## of the authentication process. This parameter allows you to specify the default redirection URL Authelia will use
## in such a case.
##
## Note: this parameter is optional. If not provided, user won't be redirected upon successful authentication.
## Note: this parameter is optional. If not provided, user won't be redirected upon successful authentication.
default_redirection_url: https://wiki.flowerhouse.at
default_redirection_url: https://wiki.MyDomain.at
 
##
## TOTP Configuration
##
## Parameters used for TOTP generation.
# totp:
  ## The issuer name displayed in the Authenticator application of your choice
  ## See: https://github.com/google/google-authenticator/wiki/Key-Uri-Format for more info on issuer names
#  issuer: authelia.com
  ## The period in seconds a one-time password is current for. Changing this will require all users to register
  ## their TOTP applications again. Warning: before changing period read the docs link below.
#  period: 30
  ## The skew controls number of one-time passwords either side of the current one that are valid.
  ## Warning: before changing skew read the docs link below.
#  skew: 1
  ## See: https://www.authelia.com/docs/configuration/one-time-password.html#period-and-skew to read the documentation.


##
## Authentication Backend Provider Configuration
## Authentication Backend Provider Configuration
##
## Used for verifying user passwords and retrieve information such as email address and groups users belong to.
##
## The available providers are: `file`, `ldap`. You must use only one of these providers.
authentication_backend:
authentication_backend:
   disable_reset_password: false
   disable_reset_password: false
Line 89: Line 48:
       key_length: 32
       key_length: 32
       salt_length: 16
       salt_length: 16
       memory: 256
       memory: 64
       parallelism: 8
       parallelism: 8


##
## Access Control Configuration
## Access Control Configuration
##
access_control:
access_control:
   ## Default policy can either be 'bypass', 'one_factor', 'two_factor' or 'deny'. It is the policy applied to any
   ## Default policy can either be 'bypass', 'one_factor', 'two_factor' or 'deny'. It is the policy applied to any
Line 108: Line 64:
   rules:
   rules:
     ## Rules applied to 'admins' group
     ## Rules applied to 'admins' group
     - domain: "*.flowerhouse.at"
     - domain: "*.MyDomain.at"
       subject: "group:admins"
       subject: "group:admins"
       policy: two_factor
       policy: two_factor


##
## Session Provider Configuration
## Session Provider Configuration
##
## The session cookies identify the user once logged in.
## The available providers are: `memory`, `redis`. Memory is the provider unless redis is defined.
session:
session:
   ## The name of the session cookie.
   ## The name of the session cookie.
Line 124: Line 76:
   ## Note: the authenticator must also be in that domain.
   ## Note: the authenticator must also be in that domain.
   ## If empty, the cookie is restricted to the subdomain of the issuer.
   ## If empty, the cookie is restricted to the subdomain of the issuer.
   domain: flowerhouse.at
   domain: MyDomain.at


   ## Sets the Cookie SameSite value. Possible options are none, lax, or strict.
   ## Sets the Cookie SameSite value. Possible options are none, lax, or strict.
Line 132: Line 84:
   ## The secret to encrypt the session data. This is only used with Redis / Redis Sentinel.
   ## The secret to encrypt the session data. This is only used with Redis / Redis Sentinel.
   ## Secret can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
   ## Secret can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
   secret: random_password_string
   secret: MY_PASSWORD
 
  ## The value for expiration, inactivity, and remember_me_duration are in seconds or the duration notation format.
  ## See: https://www.authelia.com/docs/configuration/index.html#duration-notation-format
  ## All three of these values affect the cookie/session validity period. Longer periods are considered less secure
  ## because a stolen cookie will last longer giving attackers more time to spy or attack.


   ## The time before the cookie expires and the session is destroyed if remember me IS NOT selected.
   ## The time before the cookie expires and the session is destroyed if remember me IS NOT selected.
Line 151: Line 98:
   remember_me_duration: 1M
   remember_me_duration: 1M


  ##
   ## Redis Provider
   ## Redis Provider
  ##
  ## Important: Kubernetes (or HA) users must read https://www.authelia.com/docs/features/statelessness.html
  ##
   redis:
   redis:
     host: 127.0.0.1
     host: 127.0.0.1
Line 161: Line 104:
     ## Use a unix socket instead
     ## Use a unix socket instead
     # host: /var/run/redis/redis.sock
     # host: /var/run/redis/redis.sock
    ## Username used for redis authentication. This is optional and a new feature in redis 6.0.
    # username: authelia


     ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
     ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
     password: my_redis_password
     password: MY_PASSWORD


     ## This is the Redis DB Index https://redis.io/commands/select (sometimes referred to as database number, DB, etc).
     ## This is the Redis DB Index https://redis.io/commands/select (sometimes referred to as database number, DB, etc).
Line 177: Line 117:
     minimum_idle_connections: 0
     minimum_idle_connections: 0


##
## Regulation Configuration
## Regulation Configuration
##
## This mechanism prevents attackers from brute forcing the first factor. It bans the user if too many attempts are made
## in a short period of time.
regulation:
regulation:
   ## The number of failed login attempts before user is banned. Set it to 0 to disable regulation.
   ## The number of failed login attempts before user is banned. Set it to 0 to disable regulation.
Line 195: Line 131:
   ban_time: 5m
   ban_time: 5m


##
## Storage Provider Configuration
## Storage Provider Configuration
##
## The available providers are: `local`, `mysql`, `postgres`. You must use one and only one of these providers.
storage:
storage:
  ##
   ## MySQL / MariaDB (Storage Provider)
   ## MySQL / MariaDB (Storage Provider)
  ##
   mysql:
   mysql:
     host: 192.168.88.13
     host: 192.168.88.13
Line 209: Line 140:
     username: authelia
     username: authelia
     ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
     ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
     password: my_sql_password
     password: MY_PASSWORD


##
## Notification Provider
## Notification Provider
##
## Notifications are sent to users when they require a password reset, a U2F registration or a TOTP registration.
## The available providers are: filesystem, smtp. You must use only one of these providers.
notifier:
notifier:
   ## You can disable the notifier startup check by setting this to true.
   ## You can disable the notifier startup check by setting this to true.
   disable_startup_check: false
   disable_startup_check: false


  ##
   ## SMTP (Notification Provider)
   ## SMTP (Notification Provider)
  ##
  ## Use a SMTP server for sending notifications. Authelia uses the PLAIN or LOGIN methods to authenticate.
  ## [Security] By default Authelia will:
  ##  - force all SMTP connections over TLS including unauthenticated connections
  ##      - use the disable_require_tls boolean value to disable this requirement
  ##        (only works for unauthenticated connections)
  ##  - validate the SMTP server x509 certificate during the TLS handshake against the hosts trusted certificates
  ##    (configure in tls section)
   smtp:
   smtp:
 
     username: authelia@MyDomain.at
     username: my_smtp_username
     ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
     ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
     password: my_smtp_password
     password: MY_PASSWORD
     host: smtp.mydomain.com
     host: smtp.MyDomain.com
     port: 587
     port: 587
     sender: my_mail_address
     sender: authelia@MyDomain.at
     ## HELO/EHLO Identifier. Some SMTP Servers may reject the default of localhost.
     ## HELO/EHLO Identifier. Some SMTP Servers may reject the default of localhost.
     identifier: localhost
     identifier: localhost
Line 243: Line 160:
     subject: "[Authelia] {title}"
     subject: "[Authelia] {title}"
     ## This address is used during the startup check to verify the email configuration is correct.
     ## This address is used during the startup check to verify the email configuration is correct.
    ## It's not important what it is except if your email server only allows local delivery.
     startup_check_address: authelia@MyDomain.at
     startup_check_address: authelia@flowerhouse.at
     disable_require_tls: false
     disable_require_tls: false
     disable_html_emails: false
     disable_html_emails: false


     tls:
     tls:
      ## Server Name for certificate validation (in case you are using the IP or non-FQDN in the host option).
      # server_name: smtp.example.com
       ## Skip verifying the server certificate (to allow a self-signed certificate).
       ## Skip verifying the server certificate (to allow a self-signed certificate).
      ## In preference to setting this we strongly recommend you add the public portion of the certificate to the
      ## certificates directory which is defined by the `certificates_directory` option at the top of the config.
       skip_verify: false
       skip_verify: false
       ## Minimum TLS version for either StartTLS or SMTPS.
       ## Minimum TLS version for either StartTLS or SMTPS.
       minimum_version: TLS1.2
       minimum_version: TLS1.2
</syntaxhighlight>
</syntaxhighlight>

Revision as of 21:42, 16 August 2021

############################################################################### 
#                           Authelia Configuration                            #
###############################################################################

## The host and port to listen on.
server.host: 0.0.0.0
server.port: 9091

## The theme to display: light, dark, grey.
theme: light

## Server Configuration
server:
  ## Buffers usually should be configured to be the same value.
  ## Explanation at https://www.authelia.com/docs/configuration/server.html
  read_buffer_size: 4096
  write_buffer_size: 4096
  ## Set the single level path Authelia listens on.
  ## Must be alphanumeric chars and should not contain any slashes.
  path: ""

## Level of verbosity for logs: info, debug, trace.
log.level: debug

## Format the logs are written as: json, text.
log.format: text

## File path where the logs will be written. If not set logs are written to stdout.
log.file_path: /etc/authelia/authelia.log

## The secret used to generate JWT tokens when validating user identity by email confirmation. JWT Secret can also be
## set using a secret: https://www.authelia.com/docs/configuration/secrets.html
jwt_secret: MY_PASSWORD

## Default redirection URL
## Note: this parameter is optional. If not provided, user won't be redirected upon successful authentication.
default_redirection_url: https://wiki.MyDomain.at

## Authentication Backend Provider Configuration
authentication_backend:
  disable_reset_password: false
  file:
    path: /etc/authelia/users_database.yml
    password:
      algorithm: argon2id
      iterations: 1
      key_length: 32
      salt_length: 16
      memory: 64
      parallelism: 8

## Access Control Configuration
access_control:
  ## Default policy can either be 'bypass', 'one_factor', 'two_factor' or 'deny'. It is the policy applied to any
  ## resource if there is no policy to be applied to the user.
  default_policy: deny

  networks:
    - name: internal
      networks:
        - 192.168.88.0/24

  rules:
    ## Rules applied to 'admins' group
    - domain: "*.MyDomain.at"
      subject: "group:admins"
      policy: two_factor

## Session Provider Configuration
session:
  ## The name of the session cookie.
  name: authelia_session

  ## The domain to protect.
  ## Note: the authenticator must also be in that domain.
  ## If empty, the cookie is restricted to the subdomain of the issuer.
  domain: MyDomain.at

  ## Sets the Cookie SameSite value. Possible options are none, lax, or strict.
  ## Please read https://www.authelia.com/docs/configuration/session.html#same_site
  same_site: lax

  ## The secret to encrypt the session data. This is only used with Redis / Redis Sentinel.
  ## Secret can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
  secret: MY_PASSWORD

  ## The time before the cookie expires and the session is destroyed if remember me IS NOT selected.
  expiration: 1h

  ## The inactivity time before the session is reset. If expiration is set to 1h, and this is set to 5m, if the user
  ## does not select the remember me option their session will get destroyed after 1h, or after 5m since the last time
  ## Authelia detected user activity.
  inactivity: 5m

  ## The time before the cookie expires and the session is destroyed if remember me IS selected.
  ## Value of 0 disables remember me.
  remember_me_duration: 1M

  ## Redis Provider
  redis:
    host: 127.0.0.1
    port: 6379
    ## Use a unix socket instead
    # host: /var/run/redis/redis.sock

    ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
    password: MY_PASSWORD

    ## This is the Redis DB Index https://redis.io/commands/select (sometimes referred to as database number, DB, etc).
    database_index: 0

    ## The maximum number of concurrent active connections to Redis.
    maximum_active_connections: 8

    ## The target number of idle connections to have open ready for work. Useful when opening connections is slow.
    minimum_idle_connections: 0

## Regulation Configuration
regulation:
  ## The number of failed login attempts before user is banned. Set it to 0 to disable regulation.
  max_retries: 3

  ## The time range during which the user can attempt login before being banned. The user is banned if the
  ## authentication failed 'max_retries' times in a 'find_time' seconds window. Find Time accepts duration notation.
  ## See: https://www.authelia.com/docs/configuration/index.html#duration-notation-format
  find_time: 2m

  ## The length of time before a banned user can login again. Ban Time accepts duration notation.
  ## See: https://www.authelia.com/docs/configuration/index.html#duration-notation-format
  ban_time: 5m

## Storage Provider Configuration
storage:
  ## MySQL / MariaDB (Storage Provider)
  mysql:
    host: 192.168.88.13
    port: 3306
    database: authelia
    username: authelia
    ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
    password: MY_PASSWORD

## Notification Provider
notifier:
  ## You can disable the notifier startup check by setting this to true.
  disable_startup_check: false

  ## SMTP (Notification Provider)
  smtp:
    username: authelia@MyDomain.at
    ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
    password: MY_PASSWORD
    host: smtp.MyDomain.com
    port: 587
    sender: authelia@MyDomain.at
    ## HELO/EHLO Identifier. Some SMTP Servers may reject the default of localhost.
    identifier: localhost
    ## Subject configuration of the emails sent. {title} is replaced by the text from the notifier.
    subject: "[Authelia] {title}"
    ## This address is used during the startup check to verify the email configuration is correct.
    startup_check_address: authelia@MyDomain.at
    disable_require_tls: false
    disable_html_emails: false

    tls:
      ## Skip verifying the server certificate (to allow a self-signed certificate).
      skip_verify: false
      ## Minimum TLS version for either StartTLS or SMTPS.
      minimum_version: TLS1.2