kanidm/examples/server.toml

#   The webserver bind address. Will use HTTPS if tls_* is provided.
#   Defaults to "127.0.0.1:8443"
bindaddress = "[::]:443"
#
#   The read-only ldap server bind address. The server will use LDAPS if tls_* is provided.
#   Defaults to "" (disabled)
# ldapbindaddress = "[::]:636"
#
#   The path to the kanidm database.
db_path = "/var/lib/kanidm/kanidm.db"
#
#   If you have a known filesystem, kanidm can tune sqlite to match. Valid choices are:
#   [zfs, other]
#   If you are unsure about this leave it as the default (other). After changing this
#   value you must run a vacuum task.
#   - zfs:
#     * sets sqlite pagesize to 64k. You must set recordsize=64k on the zfs filesystem.
#   - other:
#     * sets sqlite pagesize to 4k, matching most filesystems block sizes.
# db_fs_type = "zfs"
#
#   The number of entries to store in the in-memory cache. Minimum value is 256. If unset
#   an automatic heuristic is used to scale this.
# db_arc_size = 2048
#
#   TLS chain and key in pem format. Both must be commented, or both must be present
# tls_chain = "/data/chain.pem"
# tls_key = "/data/key.pem"
#
#   The log level of the server. May be default, verbose, perfbasic, perffull
#   Defaults to "default"
# log_level = "default"
#
#   The DNS domain name of the server. This is used in a
#   number of security-critical contexts
#   such as webauthn, so it *must* match your DNS
#   hostname. It is used to create
#   security principal names such as `william@idm.example.com`
#   so that in a (future)
#   trust configuration it is possible to have unique Service
#   Principal Names (spns) throughout the topology.
#   ⚠️  WARNING ⚠️
#   Changing this value WILL break many types of registered
#   credentials for accounts
#   including but not limited to webauthn, oauth tokens, and more.
#   If you change this value you *must* run
#   `kanidmd domain_name_change` immediately after.
domain = "idm.example.com"
#
#   The origin for webauthn. This is the url to the server, with the port included if
#   it is non-standard (any port except 443)
# origin = "https://idm.example.com"
origin = "https://idm.example.com:8443"
#
#   The role of this server. This affects features available and how replication may interact.
#   Valid roles are:
#   - WriteReplica
#     This server provides all functionality of Kanidm. It allows authentication, writes, and
#     the web user interface to be served.
#   - WriteReplicaNoUI
#     This server is the same as a write_replica, but does NOT offer the web user interface.
#   - ReadOnlyReplica
#     This server will not writes initiated by clients. It supports authentication and reads,
#     and must have a replication agreement as a source of it's data.
#   Defaults to "WriteReplica".
# role = "WriteReplica"
#
# [online_backup]
#   The path to the output folder for online backups
# path = "/var/lib/kanidm/backups/"
#   The schedule to run online backups - see https://crontab.guru/
#   every day at 22:00 UTC (default)
# schedule = "00 22 * * *"
#    four times a day at 3 minutes past the hour, every 6th hours
# schedule = "03 */6 * * *"
#   Number of backups to keep (default 7)
# versions = 7