nyx-bot/sample.config.toml

71 lines
2.4 KiB
TOML
Raw Normal View History

2022-09-06 10:50:14 +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
2023-02-01 13:48:51 +01:00
command_prefix= "!c"
2022-09-06 10:50:14 +02:00
2022-12-10 02:13:15 +01:00
# Enable E2EE room support ?
2023-02-01 13:48:51 +01:00
encryption = false
2022-12-10 02:13:15 +01:00
2022-09-06 10:50:14 +02:00
# Options for connecting to the bot's Matrix account
2023-02-01 13:48:51 +01:00
[matrix]
2022-09-06 10:50:14 +02:00
# The Matrix User ID of the bot account
2023-02-01 13:48:51 +01:00
user_id = "@bot:example.com"
2022-09-06 10:50:14 +02:00
# Matrix account password (optional if access token used)
2023-02-01 13:48:51 +01:00
user_password = ""
2022-09-06 10:50:14 +02:00
# Matrix account access token (optional if password used)
2022-09-14 02:48:48 +02:00
# Use the provided get_access_token.py script to get one
2023-02-01 13:48:51 +01:00
#user_token = ""
2022-09-06 10:50:14 +02:00
# The URL of the homeserver to connect to
2023-02-01 13:48:51 +01:00
homeserver_url = "https://example.com"
2022-09-06 10:50:14 +02:00
# The device ID that is **non pre-existing** device
# If this device ID already exists, messages will be dropped silently in encrypted rooms
2023-02-01 13:48:51 +01:00
device_id = "ABCDEFGHIJ"
2022-09-06 10:50:14 +02:00
# What to name the logged in device
2023-02-01 13:48:51 +01:00
device_name = "my-project-name"
2022-09-06 10:50:14 +02:00
2023-02-01 13:48:51 +01:00
[storage]
2022-09-06 10:50:14 +02:00
# The database connection string
# For SQLite3, this would look like:
# database: "sqlite://bot.db"
# For Postgres, this would look like:
# database: "postgres://username:password@localhost/dbname?sslmode=disable"
2023-02-15 03:05:33 +01:00
# For MySQL, this would look like:
# database: "mysql://username:password@localhost/dbname"
2023-02-01 13:48:51 +01:00
database = "sqlite://bot.db"
2022-09-06 10:50:14 +02:00
# The path to a directory for internal bot storage
# containing encryption keys, sync tokens, etc.
2023-02-01 13:48:51 +01:00
store_path = "./store"
2022-09-06 10:50:14 +02:00
# Logging setup
2023-02-01 13:48:51 +01:00
[logging]
2022-09-06 10:50:14 +02:00
# Logging level
# Allowed levels are 'INFO', 'WARNING', 'ERROR', 'DEBUG' where DEBUG is most verbose
2023-02-01 13:48:51 +01:00
level = "INFO"
2022-09-06 10:50:14 +02:00
# Configure logging to a file
2023-02-01 13:48:51 +01:00
[logging.file_logging]
2022-09-06 10:50:14 +02:00
# Whether logging to a file is enabled
2023-02-01 13:48:51 +01:00
enabled = false
2022-09-06 10:50:14 +02:00
# The path to the file to log to. May be relative or absolute
2023-02-01 13:48:51 +01:00
filepath = "bot.log"
2022-09-06 10:50:14 +02:00
# Configure logging to the console output
2023-02-01 13:48:51 +01:00
[logging.console_logging]
2022-09-06 10:50:14 +02:00
# Whether logging to the console is enabled
2023-02-01 13:48:51 +01:00
enabled = true
2022-09-09 08:47:13 +02:00
2023-02-01 13:48:51 +01:00
# Room features switch.
# These are the default that can be overriden by subkeys.
[room_features]
jerryxiao = false # Controls Jerry Xiao like feature.
randomdraw = false
record_messages = false # Controls recording message content.
2023-06-13 05:13:30 +02:00
join_confirm = false # Enable join confirming.
2022-11-01 04:30:57 +01:00
2023-02-01 13:48:51 +01:00
# # Toogle this room's room features.
# # You don't need to specify all of them.
# [room_features."!XXXXXXXXXXXXXXXXXX:example.com"]
# jerryxiao = false
# randomdraw = false
2023-02-15 03:05:33 +01:00
# record_messages = false