vetting-bot/sample.config.yaml

77 lines
2.6 KiB
YAML

# 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
command_prefix: "!c"
# Options for connecting to the bot's Matrix account
matrix:
# The Matrix User ID of the bot account
user_id: "@bot:example.com"
# Matrix account password (optional if access token used)
user_password: ""
# Matrix account access token (optional if password used)
#user_token: ""
# The URL of the homeserver to connect to
homeserver_url: https://example.com
# The device ID that is **non pre-existing** device
# If this device ID already exists, messages will be dropped silently in encrypted rooms
device_id: ABCDEFGHIJ
# What to name the logged in device
device_name: vetting-bot
storage:
# 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"
database: "sqlite://bot.db"
# The path to a directory for internal bot storage
# containing encryption keys, sync tokens, etc.
store_path: "./store"
# Vetting options
vetting:
# The main space, where new recruits will be invited to
main_space_id: "!xxx:xxx"
# Internal room id for the main vetting room
# Commands will be run here
vetting_room_id: "!xxx:xxx"
# A sub-space which will house all the vetting rooms
vetting_space_id: "!xxx:xxx"
# Voting time in seconds
voting_time: 172800
# Requirements for getting accepted
min_yes_votes: 1
max_no_votes: 0
# Minimum power level to automatically invite users from vetting room
power_level_invite: 10
# List of additional rooms to invite vetted members to
# The bot must be in these rooms and have the invite permission
additional_rooms: []
# Messages to send to the vetting room (optional)
# You can use the following variables:
# {mention} = https://matrix.to/#/@user:exmaple.com
message_on:
# Message to send once the invite has been confirmed
invited: "{mention}, you're in! 😎"
# 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
filepath: bot.log
# Configure logging to the console output
console_logging:
# Whether logging to the console is enabled
enabled: true