mrmBot-Matrix/.env.example

63 lines
1.8 KiB
Text
Raw Normal View History

2023-03-15 14:09:09 +00:00
############
# Required #
############
# Put environment type here (development, staging, or production)
NODE_ENV=development
2023-03-18 23:03:43 +00:00
# Put Element bot details here
# Examples:
# MATRIX_USERNAME="@mrmbot:example.com"
# MATRIX_BASEURL="https://example.com"
MATRIX_USERNAME=
MATRIX_BASEURL=
# Put Element access token here, can be found by logging into the bot account
# and scrolling down to the bottom of the "About" section in settings
2023-03-15 14:09:09 +00:00
TOKEN=
# Put the database connection URL here
# Example for SQLite:
DB=sqlite://data.sqlite
# Example for PostgreSQL:
# DB=postgresql://esmbot:verycoolpass100@localhost:5432/esmbot
2023-03-18 23:03:43 +00:00
# Put handle of bot owner here, you can have multiple separated with a comma.
# Example:
# OWNER="@murm:example.com"
2023-03-15 14:09:09 +00:00
OWNER=
# Put default classic command prefix here
PREFIX=&
############
# Optional #
############
# Set this to true if you want the bot to stay in voice chats after sound effects and music have stopped
# (you can still make the bot leave using the stop command)
STAYVC=false
# Set this to true to disable music playback from YouTube
YT_DISABLED=false
# Put Tenor API key here (used for obtaining raw tenor GIF urls)
TENOR=
# Put HTML help page output location here, leave blank to disable
OUTPUT=
# Put temporary image dir here (make sure it's accessible via a web server), leave blank to disable
TEMPDIR=
# Put temporary image web server domain
TMP_DOMAIN=
# Threshold where optional space saving methods will be performed
THRESHOLD=
# Port for serving metrics. Metrics served are compatible with Prometheus.
METRICS=
# The image API type to be used
# Set this to `none` to process all images locally
# Set this to `ws` if you want to use the external image API script, located in api/index.js
API_TYPE=none
# Put ID of server to limit owner-only commands to
ADMIN_SERVER=