|
|
|
@@ -3,13 +3,12 @@ |
|
|
|
homeserver: |
|
|
|
# The address that this appservice can use to connect to the homeserver. |
|
|
|
address: {{ matrix_mautrix_discord_homeserver_address | to_json }} |
|
|
|
# Publicly accessible base URL for media, used for avatars in relay mode. |
|
|
|
# If not set, the connection address above will be used. |
|
|
|
public_address: {{ matrix_mautrix_discord_homeserver_public_address | to_json }} |
|
|
|
# The domain of the homeserver (for MXIDs, etc). |
|
|
|
# The domain of the homeserver (also known as server_name, used for MXIDs, etc). |
|
|
|
domain: {{ matrix_mautrix_discord_homeserver_domain | to_json }} |
|
|
|
# Is the homeserver actually mautrix-asmux? |
|
|
|
asmux: false |
|
|
|
|
|
|
|
# What software is the homeserver running? |
|
|
|
# Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here. |
|
|
|
software: standard |
|
|
|
# The URL to push real-time bridge status to. |
|
|
|
# If set, the bridge will make POST requests to this URL whenever a user's discord connection state changes. |
|
|
|
# The bridge will use the appservice as_token to authorize requests. |
|
|
|
@@ -19,6 +18,13 @@ homeserver: |
|
|
|
# Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246? |
|
|
|
async_media: false |
|
|
|
|
|
|
|
# Should the bridge use a websocket for connecting to the homeserver? |
|
|
|
# The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy, |
|
|
|
# mautrix-asmux (deprecated), and hungryserv (proprietary). |
|
|
|
websocket: false |
|
|
|
# How often should the websocket be pinged? Pinging will be disabled if this is zero. |
|
|
|
ping_interval_seconds: 0 |
|
|
|
|
|
|
|
# Application service host/registration related details. |
|
|
|
# Changing these values requires regeneration of the registration. |
|
|
|
appservice: |
|
|
|
@@ -31,13 +37,14 @@ appservice: |
|
|
|
|
|
|
|
# Database config. |
|
|
|
database: |
|
|
|
# The database type. "sqlite3" and "postgres" are supported. |
|
|
|
type: {{ matrix_mautrix_discord_appservice_database_type|to_json }} |
|
|
|
# The database type. "sqlite3-fk-wal" and "postgres" are supported. |
|
|
|
type: {{ matrix_mautrix_discord_appservice_database_type | to_json }} |
|
|
|
# The database URI. |
|
|
|
# SQLite: File name is enough. https://github.com/mattn/go-sqlite3#connection-string |
|
|
|
# SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended. |
|
|
|
# https://github.com/mattn/go-sqlite3#connection-string |
|
|
|
# Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable |
|
|
|
# To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql |
|
|
|
uri: {{ matrix_mautrix_discord_appservice_database_uri|to_json }} |
|
|
|
uri: {{ matrix_mautrix_discord_appservice_database_uri | to_json }} |
|
|
|
# Maximum number of connections. Mostly relevant for Postgres. |
|
|
|
max_open_conns: 20 |
|
|
|
max_idle_conns: 2 |
|
|
|
@@ -51,15 +58,21 @@ appservice: |
|
|
|
# Appservice bot details. |
|
|
|
bot: |
|
|
|
# Username of the appservice bot. |
|
|
|
username: {{ matrix_mautrix_discord_appservice_bot_username|to_json }} |
|
|
|
username: {{ matrix_mautrix_discord_appservice_bot_username | to_json }} |
|
|
|
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty |
|
|
|
# to leave display name/avatar as-is. |
|
|
|
displayname: Discord bridge bot |
|
|
|
avatar: mxc://maunium.net/nIdEykemnwdisvHbpxflpDlC |
|
|
|
displayname: {{ matrix_mautrix_discord_appservice_bot_displayname | to_json }} |
|
|
|
avatar: {{ matrix_mautrix_discord_appservice_bot_avatar | to_json }} |
|
|
|
|
|
|
|
# Whether or not to receive ephemeral events via appservice transactions. |
|
|
|
# Requires MSC2409 support (i.e. Synapse 1.22+). |
|
|
|
ephemeral_events: true |
|
|
|
|
|
|
|
# Should incoming events be handled asynchronously? |
|
|
|
# This may be necessary for large public instances with lots of messages going through. |
|
|
|
# However, messages will not be guaranteed to be bridged in the same order they were sent in. |
|
|
|
async_transactions: false |
|
|
|
|
|
|
|
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. |
|
|
|
as_token: {{ matrix_mautrix_discord_appservice_token | to_json }} |
|
|
|
hs_token: {{ matrix_mautrix_discord_homeserver_token | to_json }} |
|
|
|
@@ -67,51 +80,67 @@ appservice: |
|
|
|
# Bridge config |
|
|
|
bridge: |
|
|
|
# Localpart template of MXIDs for Discord users. |
|
|
|
# {{ '{{.}}' }} is replaced with the internal ID of the Discord user. |
|
|
|
username_template: "{{ 'discord_{{.}}' }}" |
|
|
|
# {% raw %}{{.}}{% endraw %} is replaced with the internal ID of the Discord user. |
|
|
|
username_template: {{ matrix_mautrix_discord_bridge_username_template | to_json }} |
|
|
|
# Displayname template for Discord users. This is also used as the room name in DMs if private_chat_portal_meta is enabled. |
|
|
|
# Available variables: |
|
|
|
# {{ '{{.ID}}' }} - Internal user ID |
|
|
|
# {{ '{{.Username}}' }} - Legacy display/username on Discord |
|
|
|
# {{ '{{.GlobalName}}' }} - New displayname on Discord |
|
|
|
# {{ '{{.Discriminator}}' }} - The 4 numbers after the name on Discord |
|
|
|
# {{ '{{.Bot}}' }} - Whether the user is a bot |
|
|
|
# {{ '{{.System}}' }} - Whether the user is an official system user |
|
|
|
# {{ '{{.Webhook}}' }} - Whether the user is a webhook and is not an application |
|
|
|
# {{ '{{.Application}}' }} - Whether the user is an application |
|
|
|
displayname_template: "{{ '{{or .GlobalName .Username}}{{if .Bot}} (bot){{end}}' }}" |
|
|
|
# .ID - Internal user ID |
|
|
|
# .Username - Legacy display/username on Discord |
|
|
|
# .GlobalName - New displayname on Discord |
|
|
|
# .Discriminator - The 4 numbers after the name on Discord |
|
|
|
# .Bot - Whether the user is a bot |
|
|
|
# .System - Whether the user is an official system user |
|
|
|
# .Webhook - Whether the user is a webhook and is not an application |
|
|
|
# .Application - Whether the user is an application |
|
|
|
displayname_template: {{ matrix_mautrix_discord_bridge_displayname_template | to_json }} |
|
|
|
# Displayname template for Discord channels (bridged as rooms, or spaces when type=4). |
|
|
|
# Available variables: |
|
|
|
# {{ '{{.Name}}' }} - Channel name, or user displayname (pre-formatted with displayname_template) in DMs. |
|
|
|
# {{ '{{.ParentName}}' }} - Parent channel name (used for categories). |
|
|
|
# {{ '{{.GuildName}}' }} - Guild name. |
|
|
|
# {{ '{{.NSFW}}' }} - Whether the channel is marked as NSFW. |
|
|
|
# {{ '{{.Type}}' }} - Channel type (see values at https://github.com/bwmarrin/discordgo/blob/v0.25.0/structs.go#L251-L267) |
|
|
|
channel_name_template: "{{ '{{if or (eq .Type 3) (eq .Type 4)}}{{.Name}}{{else}}#{{.Name}}{{end}}' }}" |
|
|
|
# .Name - Channel name, or user displayname (pre-formatted with displayname_template) in DMs. |
|
|
|
# .ParentName - Parent channel name (used for categories). |
|
|
|
# .GuildName - Guild name. |
|
|
|
# .NSFW - Whether the channel is marked as NSFW. |
|
|
|
# .Type - Channel type (see values at https://github.com/bwmarrin/discordgo/blob/v0.25.0/structs.go#L251-L267) |
|
|
|
channel_name_template: {{ matrix_mautrix_discord_bridge_channel_name_template | to_json }} |
|
|
|
# Displayname template for Discord guilds (bridged as spaces). |
|
|
|
# Available variables: |
|
|
|
# {{ '{{.Name}}' }} - Guild name |
|
|
|
guild_name_template: "{{ '{{.Name}}' }}" |
|
|
|
# Should the bridge explicitly set the avatar and room name for DM portal rooms? |
|
|
|
# This is implicitly enabled in encrypted rooms. |
|
|
|
# .Name - Guild name |
|
|
|
guild_name_template: {{ matrix_mautrix_discord_bridge_guild_name_template | to_json }} |
|
|
|
# Whether to explicitly set the avatar and room name for private chat portal rooms. |
|
|
|
# If set to `default`, this will be enabled in encrypted rooms and disabled in unencrypted rooms. |
|
|
|
# If set to `always`, all DM rooms will have explicit names and avatars set. |
|
|
|
# If set to `never`, DM rooms will never have names and avatars set. |
|
|
|
private_chat_portal_meta: default |
|
|
|
|
|
|
|
# Publicly accessible base URL that Discord can use to reach the bridge, used for avatars in relay mode. |
|
|
|
# If not set, avatars will not be bridged. Only the /mautrix-discord/avatar/{server}/{id}/{hash} endpoint is used on this address. |
|
|
|
# This should not have a trailing slash, the endpoint above will be appended to the provided address. |
|
|
|
public_address: {{ matrix_mautrix_discord_bridge_public_address | to_json }} |
|
|
|
# A random key used to sign the avatar URLs. The bridge will only accept requests with a valid signature. |
|
|
|
avatar_proxy_key: {{ matrix_mautrix_discord_bridge_avatar_proxy_key | to_json }} |
|
|
|
|
|
|
|
portal_message_buffer: 128 |
|
|
|
|
|
|
|
# Number of private channel portals to create on bridge startup. |
|
|
|
# Other portals will be created when receiving messages. |
|
|
|
startup_private_channel_create_limit: 5 |
|
|
|
# Should the bridge send a read receipt from the bridge bot when a message has been sent to Discord? |
|
|
|
delivery_receipts: false |
|
|
|
# Whether the bridge should send the message status as a custom com.beeper.message_send_status event. |
|
|
|
message_status_events: true |
|
|
|
message_status_events: false |
|
|
|
# Whether the bridge should send error notices via m.notice events when a message fails to bridge. |
|
|
|
message_error_notices: true |
|
|
|
# Should the bridge use space-restricted join rules instead of invite-only for guild rooms? |
|
|
|
# This can avoid unnecessary invite events in guild rooms when members are synced in. |
|
|
|
restricted_rooms: {{ matrix_mautrix_discord_bridge_restricted_rooms|to_json }} |
|
|
|
restricted_rooms: {{ matrix_mautrix_discord_bridge_restricted_rooms | to_json }} |
|
|
|
# Should the bridge automatically join the user to threads on Discord when the thread is opened on Matrix? |
|
|
|
# This only works with clients that support thread read receipts (MSC3771 added in Matrix v1.4). |
|
|
|
autojoin_thread_on_open: true |
|
|
|
# Should inline fields in Discord embeds be bridged as HTML tables to Matrix? |
|
|
|
# Tables aren't supported in all clients, but are the only way to emulate the Discord inline field UI. |
|
|
|
embed_fields_as_tables: true |
|
|
|
# Should guild channels be muted when the portal is created? This only meant for single-user instances, |
|
|
|
# it won't mute it for all users if there are multiple Matrix users in the same Discord guild. |
|
|
|
mute_channels_on_create: false |
|
|
|
# Should the bridge update the m.direct account data event when double puppeting is enabled. |
|
|
|
# Note that updating the m.direct event is not atomic (except with mautrix-asmux) |
|
|
|
# and is therefore prone to race conditions. |
|
|
|
@@ -120,7 +149,7 @@ bridge: |
|
|
|
# This field will automatically be changed back to false after it, except if the config file is not writable. |
|
|
|
resend_bridge_info: false |
|
|
|
# Should incoming custom emoji reactions be bridged as mxc:// URIs? |
|
|
|
# If set to false, custom emoji reactions will be bridged as the shortcode instead, and the image wont be available. |
|
|
|
# If set to false, custom emoji reactions will be bridged as the shortcode instead, and the image won't be available. |
|
|
|
custom_emoji_reactions: true |
|
|
|
# Should the bridge attempt to completely delete portal rooms when a channel is deleted on Discord? |
|
|
|
# If true, the bridge will try to kick Matrix users from the room. Otherwise, the bridge only makes ghosts leave. |
|
|
|
@@ -130,7 +159,7 @@ bridge: |
|
|
|
delete_guild_on_leave: true |
|
|
|
# Whether or not created rooms should have federation enabled. |
|
|
|
# If false, created portal rooms will never be federated. |
|
|
|
federate_rooms: {{ matrix_mautrix_discord_federate_rooms|to_json }} |
|
|
|
federate_rooms: {{ matrix_mautrix_discord_federate_rooms | to_json }} |
|
|
|
# Prefix messages from webhooks with the profile info? This can be used along with a custom displayname_template |
|
|
|
# to better handle webhooks that change their name all the time (like ones used by bridges). |
|
|
|
prefix_webhook_messages: false |
|
|
|
@@ -140,24 +169,29 @@ bridge: |
|
|
|
# like the official client does? The other option is sending the media in the message send request as a form part |
|
|
|
# (which is always used by bots and webhooks). |
|
|
|
use_discord_cdn_upload: true |
|
|
|
# Proxy for Discord connections |
|
|
|
proxy: |
|
|
|
# Should mxc uris copied from Discord be cached? |
|
|
|
# This can be `never` to never cache, `unencrypted` to only cache unencrypted mxc uris, or `always` to cache everything. |
|
|
|
# If you have a media repo that generates non-unique mxc uris, you should set this to never. |
|
|
|
cache_media: unencrypted |
|
|
|
# Patterns for converting Discord media to custom mxc:// URIs instead of reuploading. |
|
|
|
# Each of the patterns can be set to null to disable custom URIs for that type of media. |
|
|
|
# Settings for converting Discord media to custom mxc:// URIs instead of reuploading. |
|
|
|
# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html |
|
|
|
media_patterns: |
|
|
|
direct_media: |
|
|
|
# Should custom mxc:// URIs be used instead of reuploading media? |
|
|
|
enabled: false |
|
|
|
# Pattern for normal message attachments. |
|
|
|
attachments: {% raw %}mxc://discord-media.mau.dev/attachments|{{.ChannelID}}|{{.AttachmentID}}|{{.FileName}}{% endraw %} |
|
|
|
# Pattern for custom emojis. |
|
|
|
emojis: {% raw %}mxc://discord-media.mau.dev/emojis|{{.ID}}.{{.Ext}}{% endraw %} |
|
|
|
# Pattern for stickers. Note that animated lottie stickers will not be converted if this is enabled. |
|
|
|
stickers: {% raw %}mxc://discord-media.mau.dev/stickers|{{.ID}}.{{.Ext}}{% endraw %} |
|
|
|
# Pattern for static user avatars. |
|
|
|
avatars: {% raw %}mxc://discord-media.mau.dev/avatars|{{.UserID}}|{{.AvatarID}}.{{.Ext}}{% endraw %} |
|
|
|
# The server name to use for the custom mxc:// URIs. |
|
|
|
# This server name will effectively be a real Matrix server, it just won't implement anything other than media. |
|
|
|
# You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge. |
|
|
|
server_name: discord-media.example.com |
|
|
|
# Optionally a custom .well-known response. This defaults to `server_name:443` |
|
|
|
well_known_response: |
|
|
|
# The bridge supports MSC3860 media download redirects and will use them if the requester supports it. |
|
|
|
# Optionally, you can force redirects and not allow proxying at all by setting this to false. |
|
|
|
allow_proxy: true |
|
|
|
# Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file. |
|
|
|
# This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them. |
|
|
|
server_key: "" |
|
|
|
# Settings for converting animated stickers. |
|
|
|
animated_sticker: |
|
|
|
# Format to which animated stickers should be converted. |
|
|
|
@@ -181,11 +215,10 @@ bridge: |
|
|
|
# If set, double puppeting will be enabled automatically for local users |
|
|
|
# instead of users having to find an access token and run `login-matrix` |
|
|
|
# manually. |
|
|
|
login_shared_secret_map: {{ matrix_mautrix_discord_bridge_login_shared_secret_map|to_json }} |
|
|
|
login_shared_secret_map: {{ matrix_mautrix_discord_bridge_login_shared_secret_map | to_json }} |
|
|
|
|
|
|
|
# The prefix for commands. Only required in non-management rooms. |
|
|
|
command_prefix: "{{ matrix_mautrix_discord_command_prefix }}" |
|
|
|
|
|
|
|
command_prefix: {{ matrix_mautrix_discord_bridge_command_prefix | to_json }} |
|
|
|
# Messages sent upon joining a management room. |
|
|
|
# Markdown is supported. The defaults are listed below. |
|
|
|
management_room_text: |
|
|
|
@@ -227,15 +260,40 @@ bridge: |
|
|
|
# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info. |
|
|
|
encryption: |
|
|
|
# Allow encryption, work in group chat rooms with e2ee enabled |
|
|
|
allow: {{ matrix_mautrix_discord_bridge_encryption_allow|to_json }} |
|
|
|
allow: {{ matrix_mautrix_discord_bridge_encryption_allow | to_json }} |
|
|
|
# Default to encryption, force-enable encryption in all portals the bridge creates |
|
|
|
# This will cause the bridge bot to be in private chats for the encryption to work properly. |
|
|
|
default: {{ matrix_mautrix_discord_bridge_encryption_default|to_json }} |
|
|
|
default: {{ matrix_mautrix_discord_bridge_encryption_default | to_json }} |
|
|
|
# Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data. |
|
|
|
appservice: {{ matrix_mautrix_discord_bridge_encryption_appservice | to_json}} |
|
|
|
# Require encryption, drop any unencrypted messages. |
|
|
|
require: false |
|
|
|
require: {{ matrix_mautrix_discord_bridge_encryption_require | to_json }} |
|
|
|
# Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled. |
|
|
|
# You must use a client that supports requesting keys from other users to use this feature. |
|
|
|
allow_key_sharing: {{ matrix_mautrix_discord_bridge_encryption_key_sharing_allow|to_json }} |
|
|
|
allow_key_sharing: {{ matrix_mautrix_discord_bridge_encryption_key_sharing_allow | to_json }} |
|
|
|
# Should users mentions be in the event wire content to enable the server to send push notifications? |
|
|
|
plaintext_mentions: {{ matrix_mautrix_discord_bridge_encryption_plaintext_mentions | to_json }} |
|
|
|
# Options for deleting megolm sessions from the bridge. |
|
|
|
delete_keys: |
|
|
|
# Beeper-specific: delete outbound sessions when hungryserv confirms |
|
|
|
# that the user has uploaded the key to key backup. |
|
|
|
delete_outbound_on_ack: false |
|
|
|
# Don't store outbound sessions in the inbound table. |
|
|
|
dont_store_outbound: false |
|
|
|
# Ratchet megolm sessions forward after decrypting messages. |
|
|
|
ratchet_on_decrypt: false |
|
|
|
# Delete fully used keys (index >= max_messages) after decrypting messages. |
|
|
|
delete_fully_used_on_decrypt: false |
|
|
|
# Delete previous megolm sessions from same device when receiving a new one. |
|
|
|
delete_prev_on_new_session: false |
|
|
|
# Delete megolm sessions received from a device when the device is deleted. |
|
|
|
delete_on_device_delete: false |
|
|
|
# Periodically delete megolm sessions when 2x max_age has passed since receiving the session. |
|
|
|
periodically_delete_expired: false |
|
|
|
# Delete inbound megolm sessions that don't have the received_at field used for |
|
|
|
# automatic ratcheting and expired session deletion. This is meant as a migration |
|
|
|
# to delete old keys prior to the bridge update. |
|
|
|
delete_outdated_inbound: false |
|
|
|
# What level of device verification should be required from users? |
|
|
|
# |
|
|
|
# Valid levels: |
|
|
|
@@ -271,6 +329,10 @@ bridge: |
|
|
|
# default. |
|
|
|
messages: 100 |
|
|
|
|
|
|
|
# Disable rotating keys when a user's devices change? |
|
|
|
# You should not enable this option unless you understand all the implications. |
|
|
|
disable_device_change_key_rotation: false |
|
|
|
|
|
|
|
# Settings for provisioning API |
|
|
|
provisioning: |
|
|
|
# Prefix for the provisioning API paths. |
|
|
|
@@ -278,6 +340,8 @@ bridge: |
|
|
|
# Shared secret for authentication. If set to "generate", a random secret will be generated, |
|
|
|
# or if set to "disable", the provisioning API will be disabled. |
|
|
|
shared_secret: {{ matrix_mautrix_discord_provisioning_shared_secret | to_json }} |
|
|
|
# Enable debug API at /debug with provisioning authentication. |
|
|
|
debug_endpoints: false |
|
|
|
|
|
|
|
# Permissions for using the bridge. |
|
|
|
# Permitted values: |
|
|
|
@@ -290,12 +354,9 @@ bridge: |
|
|
|
# mxid - Specific user |
|
|
|
permissions: {{ matrix_mautrix_discord_bridge_permissions|to_json }} |
|
|
|
|
|
|
|
# Logging config. See https://github.com/tulir/zeroconfig for details. |
|
|
|
logging: |
|
|
|
directory: ./logs |
|
|
|
file_name_format: '' |
|
|
|
file_date_format: "2006-01-02" |
|
|
|
file_mode: 384 |
|
|
|
timestamp_format: Jan _2, 2006 15:04:05 |
|
|
|
print_level: {{ matrix_mautrix_discord_logging_level | to_json }} |
|
|
|
print_json: false |
|
|
|
file_json: false |
|
|
|
min_level: {{ matrix_mautrix_discord_logging_level | to_json }} |
|
|
|
writers: |
|
|
|
- type: stdout |
|
|
|
format: pretty-colored |