# Sample configuration file explaining the minimum required keys to be set to run mxisd
#
# For a complete list of options, see https://github.com/kamax-matrix/mxisd/docs/README.md

#######################
# Matrix config items #
#######################
# Matrix domain, same as the domain configure in your Homeserver configuration.
# NOTE: in Synapse Homeserver, the Matrix domain is defined as 'server_name' in configuration file.
#
# This is used to build the various identifiers in all the features.
matrix:
  domain: ''


################
# Signing keys #
################
# Absolute path for the Identity Server signing key.
# This is **NOT** your homeserver key.
# The signing key is auto-generated during execution time if not present.
#
# During testing, /var/tmp/mxisd.key is a possible value
# For production, recommended location shall be one of the following:
#   - /var/opt/mxisd/sign.key
#   - /var/local/mxisd/sign.key
#   - /var/lib/mxisd/sign.key
#
key:
  path: ''


# Path to the SQLite DB file for mxisd internal storage
#
# Examples:
#  - /var/opt/mxisd/mxisd.db
#  - /var/local/mxisd/mxisd.db
#  - /var/lib/mxisd/mxisd.db
#
storage:
  provider:
    sqlite:
      database: '/path/to/mxisd.db'


####################
# Fallback servers #
####################
#
# Root/Central servers to be used as final fallback when performing lookups.
# By default, for privacy reasons, matrix.org servers are not enabled.
# See the following issue: https://github.com/kamax-matrix/mxisd/issues/76
#
# If you would like to use them and trade away your privacy for convenience, uncomment the following option:
#
#forward:
#  servers: ['matrix-org']


################
# LDAP Backend #
################
# If you would like to integrate with your AD/Samba/LDAP server,
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/ldap.md


###############
# SQL Backend #
###############
# If you would like to integrate with a MySQL/MariaDB/PostgreQL/SQLite DB,
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/sql.md


################
# REST Backend #
################
# If you would like to integrate with an existing web service/webapp,
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/rest.md


#################################################
# Notifications for invites/addition to profile #
#################################################
# If you would like to change the content,
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/threepids/notification/template-generator.md
#
#### E-mail invite sender
threepid:
  medium:
    email:
      identity:
        # The e-mail to send as.
        from: "matrix-identity@example.org"

      connectors:
        smtp:
          # SMTP host
          host: "smtp.example.org"

          # SMTP port
          port: 587

          # TLS mode for the connection.
          #
          # Possible values:
          #  0    Disable TLS entirely
          #  1    Enable TLS if supported by server (default)
          #  2    Force TLS and fail if not available
          #
          tls: 1

          # Login for SMTP
          login: "matrix-identity@example.org"

          # Password for the account
          password: "ThePassword"