matrix-puppeteer-line/matrix_puppeteer_line/example-config.yaml

194 lines
8.2 KiB
YAML
Raw Permalink Normal View History

# Homeserver details
homeserver:
# The address that this appservice can use to connect to the homeserver.
address: https://example.com
# The domain of the homeserver (for MXIDs, etc).
domain: example.com
# Whether or not to verify the SSL certificate of the homeserver.
# Only applies if address starts with https://
verify_ssl: true
# Application service host/registration related details
# Changing these values requires regeneration of the registration.
appservice:
# The address that the homeserver can use to connect to this appservice.
2020-08-28 09:38:06 -04:00
address: http://localhost:29394
# When using https:// the TLS certificate and key files for the address.
tls_cert: false
tls_key: false
# The hostname and port where this appservice should listen.
hostname: 0.0.0.0
2020-08-28 09:38:06 -04:00
port: 29394
# The maximum body size of appservice API requests (from the homeserver) in mebibytes
# Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s
max_body_size: 1
# The full URI to the database. Only Postgres is currently supported.
database: postgres://username:password@hostname/db
# Provisioning API part of the web server for automated portal creation and fetching information.
# Used by things like mautrix-manager (https://github.com/tulir/mautrix-manager).
provisioning:
# Whether or not the provisioning API should be enabled.
enabled: true
# The prefix to use in the provisioning API endpoints.
prefix: /_matrix/provision/v1
# The shared secret to authorize users of the API.
# Set to "generate" to generate and save a new token.
shared_secret: generate
# The unique ID of this appservice.
2021-02-10 02:34:19 -05:00
id: line
# Username of the appservice bot.
2021-02-10 02:34:19 -05:00
bot_username: linebot
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
# to leave display name/avatar as-is.
2021-02-10 02:34:19 -05:00
bot_displayname: LINE bridge bot
2021-07-02 14:10:35 -04:00
bot_avatar: mxc://miscworks.net/vkVOqyfLTQTfRvlEgEoampPW
# Community ID for bridged users (changes registration file) and rooms.
# Must be created manually.
#
2021-02-10 02:34:19 -05:00
# Example: "+line:example.com". Set to false to disable.
community_id: false
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
as_token: "This value is generated when generating the registration"
hs_token: "This value is generated when generating the registration"
# Whether or not to receive ephemeral events via appservice transactions.
# Requires MSC2409 support (i.e. Synapse 1.22+).
# This is REQUIRED in order to bypass Puppeteer needing to "view" a LINE chat
# (thus triggering a LINE read receipt on your behalf) to sync its messages.
ephemeral_events: false
# Prometheus telemetry config. Requires prometheus-client to be installed.
metrics:
enabled: false
listen_port: 8000
# Bridge config
bridge:
# Localpart template of MXIDs for remote users.
# {userid} is replaced with the user ID (phone or name converted into a mxid-friendly format).
2021-02-10 02:34:19 -05:00
username_template: "line_{userid}"
# Displayname template for remote users.
# {displayname} is replaced with the display name of the user.
# {phone} is replaced with the phone number or name of the user.
2021-02-10 02:34:19 -05:00
displayname_template: "{displayname} (LINE)"
# Maximum length of displayname
displayname_max_length: 100
2021-07-22 03:23:11 -04:00
# Number of conversations to sync (and create portals for) on login
# and with the "sync" command with no numeric argument passed to it.
# Set 0 to disable automatic syncing on login.
initial_conversation_sync: 10
2021-02-25 22:21:11 -05:00
# Whether or not the LINE users of logged in Matrix users should be
# invited to rooms when the user sends a message from another client.
# NOTE: This setting is forced to "false" when custom puppets are enabled.
2021-02-25 22:21:11 -05:00
invite_own_puppet_to_pm: false
# Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth
#
# If set, custom puppets will be enabled automatically for local users
# instead of users having to find an access token and run `login-matrix`
# manually.
login_shared_secret: null
# Whether or not created rooms should have federation enabled.
# If false, created portal rooms will never be federated.
federate_rooms: true
2021-07-22 03:23:11 -04:00
# Settings for backfilling messages.
backfill:
# If using double puppeting, should notifications be disabled
# while the initial backfill is in progress?
disable_notifications: false
# End-to-bridge encryption support options. These require matrix-nio to be installed with pip
# and login_shared_secret to be configured in order to get a device for the bridge bot.
#
# Additionally, https://github.com/matrix-org/synapse/pull/5758 is required if using a normal
# application service.
encryption:
# Allow encryption, work in group chat rooms with e2ee enabled
allow: false
# 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: false
# Options for automatic key sharing.
key_sharing:
# 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: false
# Require the requesting device to have a valid cross-signing signature?
# This doesn't require that the bridge has verified the device, only that the user has verified it.
# Not yet implemented.
require_cross_signing: false
# Require devices to be verified by the bridge?
# Verification by the bridge is not yet implemented.
require_verification: true
# Whether or not to explicitly set the avatar and room name for private
# chat portal rooms. This will be implicitly enabled if encryption.default is true.
private_chat_portal_meta: false
# Whether or not the bridge should send a read receipt from the bridge bot when a message has
# been sent.
delivery_receipts: false
# Whether or not delivery errors should be reported as messages in the Matrix room.
delivery_error_reports: false
# Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
# This field will automatically be changed back to false after it,
# except if the config file is not writable.
resend_bridge_info: false
# Set this to false to disable bridging stickers and emoji.
receive_stickers: true
# Set this to false to use m.image events for stickers instead of m.sticker.
use_sticker_events: true
# The scale by which to display emojis with. Must be a positive integer.
emoji_scale_factor: 1
# The prefix for commands. Only required in non-management rooms.
2021-02-10 02:34:19 -05:00
command_prefix: "!line"
2020-08-28 09:38:06 -04:00
# This bridge only supports a single user
user: "@admin:example.com"
2020-08-28 09:38:06 -04:00
puppeteer:
connection:
# Either unix or tcp
type: unix
# Only for type: unix
2021-03-15 01:40:56 -04:00
path: /var/run/matrix-puppeteer-line/puppet.sock
2020-08-28 09:38:06 -04:00
# Only for type: tcp
host: localhost
port: 29395
# Python logging configuration.
#
# See section 16.7.2 of the Python documentation for more info:
# https://docs.python.org/3.6/library/logging.config.html#configuration-dictionary-schema
logging:
version: 1
formatters:
colored:
2021-03-15 01:40:56 -04:00
(): matrix_puppeteer_line.util.ColorFormatter
format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
normal:
format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
handlers:
file:
class: logging.handlers.RotatingFileHandler
formatter: normal
2021-03-15 01:40:56 -04:00
filename: ./matrix-puppeteer-line.log
maxBytes: 10485760
backupCount: 10
console:
class: logging.StreamHandler
formatter: colored
loggers:
mau:
level: DEBUG
aiohttp:
level: INFO
root:
level: DEBUG
handlers: [file, console]