matrix-alertbot/config.sample.yaml

88 lines
2.8 KiB
YAML
Raw Normal View History

2019-09-25 14:26:29 +02:00
# Welcome to the sample config file
# Below you will find various config sections and options
# Default values are shown
# The string to prefix messages with to talk to the bot in group chats
2022-08-08 16:43:05 +02:00
command_prefix: "!alert"
2019-09-25 14:26:29 +02:00
# Options for connecting to the bot's Matrix account
matrix:
# The Matrix User ID of the bot account
2022-08-08 16:43:05 +02:00
user_id: "@bot:matrix.example.com"
2022-10-26 13:25:47 +02:00
# Matrix account password (optional if access token used)
2022-08-08 16:43:05 +02:00
user_password: "password"
2022-10-26 13:25:47 +02:00
# Matrix account access token (optional if password used)
2022-10-26 13:25:47 +02:00
# If not set, the server will provide an access token after log in,
# which will be stored in the user token file (see below)
#user_token: ""
2022-10-26 13:25:47 +02:00
# Path to the file where to store the user access token
user_token_file: "token.json"
2019-09-25 14:26:29 +02:00
# The URL of the homeserver to connect to
2022-08-08 16:43:05 +02:00
url: https://matrix.example.com
2022-10-26 13:25:47 +02:00
2020-02-24 23:13:28 +01:00
# The device ID that is **non pre-existing** device
# If this device ID already exists, messages will be dropped silently in encrypted rooms
2022-10-26 13:25:47 +02:00
# If not set the server will provide a device ID after log in. Note that this ID
2022-08-27 13:46:58 +02:00
# will change each time the bot reconnects.
# device_id: ABCDEFGHIJ
2022-10-26 13:25:47 +02:00
2020-02-24 23:13:28 +01:00
# What to name the logged in device
2022-06-13 20:55:01 +02:00
device_name: matrix-alertbot
2022-10-26 13:25:47 +02:00
2022-08-08 16:43:05 +02:00
# List of rooms where the bot can interact
allowed_rooms:
- "!abcdefgh:matrix.example.com"
2022-10-26 13:25:47 +02:00
2022-08-08 16:43:05 +02:00
# List of allowed reactions to create silences.
# Default is listed here.
allowed_reactions: [🤫, 😶, 🤐, 🙊, 🔇, 🔕]
webhook:
# Address and port for which the bot should listen to
address: 0.0.0.0
port: 8080
# Path to the socket for which the bot should listen to.
# This is mutually exclusive with webhook.address option.
socket: /path/to/matrix-alertbot.sock
alertmanager:
# Url to Alertmanager server
url: http://localhost:9093
cache:
# The path to a directory for caching alerts and silences
path: "./cache"
2019-09-25 14:26:29 +02:00
2020-02-24 23:13:28 +01:00
storage:
# The path to a directory for internal bot storage
# containing encryption keys, sync tokens, etc.
2022-08-08 16:43:05 +02:00
path: "./store"
template:
# Path to directory that contains templates for rendering alerts.
2022-10-26 13:25:47 +02:00
# The directory must contains the files "alert.html.j2" and "alert.txt.j2"
# and must respect Jinja2 templating format.
# Default is to use templates provided by the matrix_alertbot package.
# These templates are available in "matrix_alertbot/resources/templates".
2022-08-08 16:43:05 +02:00
path: "data/templates"
2019-09-25 14:26:29 +02:00
# Logging setup
logging:
# Logging level
# Allowed levels are 'INFO', 'WARNING', 'ERROR', 'DEBUG' where DEBUG is most verbose
level: INFO
# Configure logging to a file
file_logging:
# Whether logging to a file is enabled
enabled: false
# The path to the file to log to. May be relative or absolute
2022-08-08 16:43:05 +02:00
filepath: matrix-alertbot.log
2019-09-25 14:26:29 +02:00
# Configure logging to the console output
console_logging:
# Whether logging to the console is enabled
enabled: true