maubot/example-config.yaml

112 lines
3.9 KiB
YAML
Raw Normal View History

2018-10-14 19:08:11 +00:00
# The full URI to the database. SQLite and Postgres are fully supported.
# Other DBMSes supported by SQLAlchemy may or may not work.
# Format examples:
# SQLite: sqlite:///filename.db
# Postgres: postgres://username:password@hostname/dbname
2018-09-23 14:56:21 +00:00
database: sqlite:///maubot.db
# Database for encryption data.
crypto_database:
# Type of database. Either "default", "pickle" or "postgres".
# When set to default, using SQLite as the main database will use pickle as the crypto database
# and using Postgres as the main database will use the same one as the crypto database.
#
# When using pickle, individual crypto databases are stored in the pickle_dir directory.
# When using non-default postgres, postgres_uri is used to connect to postgres.
type: default
postgres_uri: postgres://username:password@hostname/dbname
pickle_dir: ./crypto
2018-06-13 22:41:05 +00:00
plugin_directories:
# The directory where uploaded new plugins should be stored.
upload: ./plugins
# The directories from which plugins should be loaded.
# Duplicate plugin IDs will be moved to the trash.
load:
- ./plugins
# The directory where old plugin versions and conflicting plugins should be moved.
# Set to "delete" to delete files immediately.
trash: ./trash
# The directory where plugin databases should be stored.
db: ./plugins
2018-06-13 22:41:05 +00:00
server:
2018-10-16 13:41:02 +00:00
# The IP and port to listen to.
hostname: 0.0.0.0
port: 29316
2019-03-06 20:35:51 +00:00
# Public base URL where the server is visible.
public_url: https://example.com
2018-10-14 19:08:11 +00:00
# The base management API path.
base_path: /_matrix/maubot/v1
# The base path for the UI.
ui_base_path: /_matrix/maubot
# The base path for plugin endpoints. The instance ID will be appended directly.
plugin_base_path: /_matrix/maubot/plugin/
# Override path from where to load UI resources.
# Set to false to using pkg_resources to find the path.
override_resource_path: false
2018-10-14 19:08:11 +00:00
# The base appservice API path. Use / for legacy appservice API and /_matrix/app/v1 for v1.
appservice_base_path: /_matrix/app/v1
# The shared secret to sign API access tokens.
2018-10-14 19:08:11 +00:00
# Set to "generate" to generate and save a new token at startup.
unshared_secret: generate
2018-09-23 14:56:21 +00:00
# Shared registration secrets to allow registering new users from the management UI
registration_secrets:
example.com:
# Client-server API URL
url: https://example.com
# registration_shared_secret from synapse config
secret: synapse_shared_registration_secret
# List of administrator users. Plaintext passwords will be bcrypted on startup. Set empty password
# to prevent normal login. Root is a special user that can't have a password and will always exist.
2018-09-26 07:32:24 +00:00
admins:
root: ""
2018-09-26 07:32:24 +00:00
# API feature switches.
api_features:
login: true
plugin: true
plugin_upload: true
instance: true
instance_database: true
client: true
client_proxy: true
client_auth: true
dev_open: true
log: true
2018-09-23 14:56:21 +00:00
# Python logging configuration.
#
# See section 16.7.2 of the Python documentation for more info:
# https://docs.python.org/3.6/library/logging.config.html#configuration-dictionary-schema
logging:
version: 1
formatters:
colored:
(): maubot.lib.color_log.ColorFormatter
format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
normal:
2018-09-23 14:56:21 +00:00
format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
handlers:
file:
class: logging.handlers.RotatingFileHandler
formatter: normal
filename: ./maubot.log
2018-09-23 14:56:21 +00:00
maxBytes: 10485760
backupCount: 10
console:
class: logging.StreamHandler
formatter: colored
2018-09-23 14:56:21 +00:00
loggers:
maubot:
level: DEBUG
2018-09-26 07:32:24 +00:00
mautrix:
level: DEBUG
2018-09-23 14:56:21 +00:00
aiohttp:
level: INFO
root:
level: DEBUG
2018-09-26 07:32:24 +00:00
handlers: [file, console]