Configuration.yml: Difference between revisions

From FlowerHouseWiki
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
<syntaxhighlight lang="yaml" line>
<syntaxhighlight lang="YAML" line>
###############################################################
###############################################################################  
#                   Authelia configuration                    #
#                           Authelia Configuration                            #
###############################################################
###############################################################################


# The host and port to listen on
## The host and port to listen on.
host: 192.168.88.9
server.host: 0.0.0.0
port: 9091
server.port: 9091
tls_key: /etc/letsencrypt/live/flowerhouse.at/privkey.pem
tls_cert: /etc/letsencrypt/live/flowerhouse.at/fullchain.pem


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


# Configuration options specific to the internal http server
## 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://docs.authelia.com/configuration/server.html
   ## Explanation at https://www.authelia.com/docs/configuration/server.html
  # Read buffer size configures the http server's maximum incoming request size in bytes.
   read_buffer_size: 4096
   read_buffer_size: 4096
  # Write buffer size configures the http server's maximum outgoing response size in bytes.
   write_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.
   ## Set the single level path Authelia listens on.
  ## Must be alphanumeric chars and should not contain any slashes.
   path: ""
   path: ""


# 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
# log_format: json
# File path where the logs will be written. If not set logs are written to stdout.
# log_file_path: /config/authelia.log


# The secret used to generate JWT tokens when validating user identity by
## Format the logs are written as: json, text.
# email confirmation.
log.format: text
# JWT Secret can also be set using a secret: https://docs.authelia.com/configuration/secrets.html
jwt_secret: a_very_important_secret


# Default redirection URL
## File path where the logs will be written. If not set logs are written to stdout.
#
log.file_path: /etc/authelia/authelia.log
# 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.
default_redirection_url: https://home.example.com:8080/


# TOTP Settings
## 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
# Parameters used for TOTP generation
jwt_secret: MY_PASSWORD
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://docs.authelia.com/configuration/one-time-password.html#period-and-skew to read the documentation.


# Duo Push API
## Default redirection URL
#
## Note: this parameter is optional. If not provided, user won't be redirected upon successful authentication.
# Parameters used to contact the Duo API. Those are generated when you protect an application
default_redirection_url: https://wiki.MyDomain.at
# of type "Partner Auth API" in the management panel.
duo_api:
  hostname: api-123456789.example.com
  integration_key: ABCDEF
  # Secret can also be set using a secret: https://docs.authelia.com/configuration/secrets.html
  secret_key: 1234567890abcdefghifjkl


# The authentication backend to use for verifying user passwords
## Authentication Backend Provider Configuration
# and retrieve information such as email address and groups
# users belong to.
#
# There are two supported backends: 'ldap' and 'file'.
authentication_backend:
authentication_backend:
  # Disable both the HTML element and the API for reset password functionality
   disable_reset_password: false
   disable_reset_password: false
  # File backend configuration.
  #
  # With this backend, the users database is stored in a file
  # which is updated when users reset their passwords.
  # Therefore, this backend is meant to be used in a dev environment
  # and not in production since it prevents Authelia to be scaled to
  # more than one instance. The options under 'password' have sane
  # defaults, and as it has security implications it is highly recommended
  # you leave the default values. Before considering changing these settings
  # please read the docs page below:
  # https://docs.authelia.com/configuration/authentication/file.html#password-hash-algorithm-tuning
   file:
   file:
     path: /etc/authelia/users_database.yml
     path: /etc/authelia/users_database.yml
Line 100: Line 46:
       algorithm: argon2id
       algorithm: argon2id
       iterations: 1
       iterations: 1
      key_length: 32
       salt_length: 16
       salt_length: 16
      memory: 64
       parallelism: 8
       parallelism: 8
      memory: 1024


# Access Control
## Access Control Configuration
#
# Access control is a list of rules defining the authorizations applied for one
# resource to users or group of users.
#
# If 'access_control' is not defined, ACL rules are disabled and the 'bypass'
# rule is applied, i.e., access is allowed to anyone. Otherwise restrictions follow
# the rules defined.
#
# Note: One can use the wildcard * to match any subdomain.
# It must stand at the beginning of the pattern. (example: *.mydomain.com)
#
# Note: You must put patterns containing wildcards between simple quotes for the YAML
# to be syntactically correct.
#
# Definition: A 'rule' is an object with the following keys: 'domain', 'subject',
# 'policy' and 'resources'.
#
# - 'domain' defines which domain or set of domains the rule applies to.
#
# - 'subject' defines the subject to apply authorizations to. This parameter is
#    optional and matching any user if not provided. If provided, the parameter
#    represents either a user or a group. It should be of the form 'user:<username>'
#    or 'group:<groupname>'.
#
# - 'policy' is the policy to apply to resources. It must be either 'bypass',
#  'one_factor', 'two_factor' or 'deny'.
#
# - 'resources' is a list of regular expressions that matches a set of resources to
#    apply the policy to. This parameter is optional and matches any resource if not
#    provided.
#
# Note: the order of the rules is important. The first policy matching
# (domain, resource, subject) applies.
access_control:
access_control:
   # Default policy can either be 'bypass', 'one_factor', 'two_factor' or 'deny'.
   ## Default policy can either be 'bypass', 'one_factor', 'two_factor' or 'deny'. It is the policy applied to any
  # It is the policy applied to any resource if there is no policy to be applied
  ## resource if there is no policy to be applied to the user.
  # to the user.
   default_policy: deny
   default_policy: bypass
 
  networks:
    - name: internal
      networks:
        - 192.168.88.0/24


   rules:
   rules:
     # Rules applied to everyone
     ## Rules applied to 'admins' group
     - domain: wiki.flowerhouse.at
     - domain: "*.MyDomain.at"
       policy: bypass
       subject: "group:admins"
 
    - domain: ve.flowerhouse.at
       policy: two_factor
       policy: two_factor


# Configuration of session cookies
## Session Provider Configuration
#
# The session cookies identify the user once logged in.
session:
session:
   # The name of the session cookie. (default: authelia_session).
   ## The name of the session cookie.
   name: flowerhouse_session
  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.
   ## The secret to encrypt the session data. This is only used with Redis / Redis Sentinel.
   # Secret can also be set using a secret: https://docs.authelia.com/configuration/secrets.html
   ## Secret can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
   secret: insecure_session_secret
   secret: MY_PASSWORD


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


   # The inactivity time in seconds before the session is reset.
   ## 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
   inactivity: 5m


   # The remember me duration.
   ## The time before the cookie expires and the session is destroyed if remember me IS selected.
   # Value of 0 disables remember me.
   ## Value of 0 disables remember me.
  # Value is in seconds, or duration notation. See: https://docs.authelia.com/configuration/index.html#duration-notation-format
  # Longer periods are considered less secure because a stolen cookie will last longer giving attackers more time to spy
  # or attack. Currently the default is 1M or 1 month.
   remember_me_duration: 1M
   remember_me_duration: 1M


   # The domain to protect.
   ## Redis Provider
  # Note: the authenticator must also be in that domain. If empty, the cookie
  # is restricted to the subdomain of the issuer.
  domain: example.com
 
  # The redis connection details
   redis:
   redis:
     host: 127.0.0.1
     host: 127.0.0.1
     port: 6379
     port: 6379
     # Use a unix socket instead
     ## Use a unix socket instead
     # host: /var/run/redis/redis.sock
     # host: /var/run/redis/redis.sock


     # Password can also be set using a secret: https://docs.authelia.com/configuration/secrets.html
     ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
     password: authelia
     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).
     database_index: 0
     database_index: 0


# Configuration of the authentication regulation mechanism.
    ## The maximum number of concurrent active connections to Redis.
#
    maximum_active_connections: 8
# This mechanism prevents attackers from brute forcing the first factor.
 
# It bans the user if too many attempts are done in a short period of
    ## The target number of idle connections to have open ready for work. Useful when opening connections is slow.
# time.
    minimum_idle_connections: 0
 
## Regulation Configuration
regulation:
regulation:
   # The number of failed login attempts before user is banned.
   ## The number of failed login attempts before user is banned. Set it to 0 to disable regulation.
  # Set it to 0 to disable regulation.
   max_retries: 3
   max_retries: 3


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


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


# Configuration of the storage backend used to store data and secrets.
## Storage Provider Configuration
# You must use only an available configuration: local, mysql, postgres
storage:
storage:
   # Settings to connect to MySQL server
   ## The encryption key that is used to encrypt sensitive information in the database. Must be a string with a minimum
  ## length of 20. Please see the docs if you configure this with an undesirable key and need to change it.
  encryption_key: MY_PASSWORD
 
  ## MySQL / MariaDB (Storage Provider)
   mysql:
   mysql:
     host: 192.168.88.13
     host: 192.168.88.13
Line 221: Line 143:
     database: authelia
     database: authelia
     username: authelia
     username: authelia
     # Password can also be set using a secret: https://docs.authelia.com/configuration/secrets.html
     ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
     password: JTurmmdVJrMsmNrc
     password: MY_PASSWORD


# Configuration of the notification system.
## Notification Provider
#
# Notifications are sent to users when they require a password reset, a u2f
# registration or a TOTP registration.
# Use only an available configuration: filesystem, smtp.
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


   # For testing purpose, notifications can be sent in a file
   ## SMTP (Notification Provider)
  ## filesystem:
  ##  filename: /config/notification.txt
 
  # Use a SMTP server for sending notifications. Authelia uses PLAIN or LOGIN method 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: test
     username: authelia@MyDomain.at
     # Password can also be set using a secret: https://docs.authelia.com/configuration/secrets.html
     ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
     password: password
     password: MY_PASSWORD
     host: 127.0.0.1
     host: smtp.MyDomain.com
     port: 25
     port: 587
     sender: admin@example.com
     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
     # Subject configuration of the emails sent.
     ## Subject configuration of the emails sent. {title} is replaced by the text from the notifier.
    # {title} is replaced by the text from the notifier
     subject: "[Authelia] {title}"
     subject: "[Authelia] {title}"
     # 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.
     ## This address is used during the startup check to verify the email configuration is correct.
     startup_check_address: test@authelia.com
     startup_check_address: authelia@MyDomain.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).
       ## Skip verifying the server certificate (to allow a self-signed certificate).
      # server_name: smtp.example.com
 
      # Skip verifying the server certificate (to allow a self-signed certificate).
       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>

Latest revision as of 21:54, 17 December 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:
  ## The encryption key that is used to encrypt sensitive information in the database. Must be a string with a minimum
  ## length of 20. Please see the docs if you configure this with an undesirable key and need to change it.
  encryption_key: MY_PASSWORD

  ## 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