mirror of
				https://github.com/spantaleev/matrix-docker-ansible-deploy.git
				synced 2025-10-30 23:07:57 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			240 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Django/Jinja
		
	
	
	
	
	
			
		
		
	
	
			240 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Django/Jinja
		
	
	
	
	
	
| #jinja2: lstrip_blocks: "True"
 | |
| # Homeserver details
 | |
| homeserver:
 | |
|     # The address that this appservice can use to connect to the homeserver.
 | |
|     address: {{ matrix_mautrix_signal_homeserver_address }}
 | |
|     # The domain of the homeserver (for MXIDs, etc).
 | |
|     domain: {{ matrix_mautrix_signal_homeserver_domain }}
 | |
|     # Whether or not to verify the SSL certificate of the homeserver.
 | |
|     # Only applies if address starts with https://
 | |
|     verify_ssl: true
 | |
|     asmux: false
 | |
|     # Number of retries for all HTTP requests if the homeserver isn't reachable.
 | |
|     http_retry_count: 4
 | |
|     # The URL to push real-time bridge status to.
 | |
|     # If set, the bridge will make POST requests to this URL whenever a user's Signal connection state changes.
 | |
|     # The bridge will use the appservice as_token to authorize requests.
 | |
|     status_endpoint: null
 | |
| 
 | |
| # 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.
 | |
|     address: {{ matrix_mautrix_signal_appservice_address }}
 | |
|     # 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
 | |
|     port: 29328
 | |
|     # 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: {{ matrix_mautrix_signal_database_connection_string }}
 | |
|     # Additional arguments for asyncpg.create_pool()
 | |
|     # https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.pool.create_pool
 | |
|     database_opts:
 | |
|         min_size: 5
 | |
|         max_size: 10
 | |
| 
 | |
|     # 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.
 | |
|     id: signal
 | |
|     # Username of the appservice bot.
 | |
|     bot_username: {{ matrix_mautrix_signal_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.
 | |
|     bot_displayname: Signal bridge bot
 | |
|     bot_avatar: mxc://maunium.net/wPJgTQbZOtpBFmDNkiNEMDUp
 | |
| 
 | |
|     # Community ID for bridged users (changes registration file) and rooms.
 | |
|     # Must be created manually.
 | |
|     #
 | |
|     # Example: "+signal:example.com". Set to false to disable.
 | |
|     community_id: false
 | |
| 
 | |
|     # Authentication tokens for AS <-> HS communication.
 | |
|     as_token: "{{ matrix_mautrix_signal_appservice_token }}"
 | |
|     hs_token: "{{ matrix_mautrix_signal_homeserver_token }}"
 | |
| 
 | |
| # Prometheus telemetry config. Requires prometheus-client to be installed.
 | |
| metrics:
 | |
|     enabled: false
 | |
|     listen_port: 8000
 | |
| 
 | |
| signal:
 | |
|     # Path to signald unix socket
 | |
|     socket_path: /signald/signald.sock
 | |
|     # Directory for temp files when sending files to Signal. This should be an
 | |
|     # absolute path that signald can read. For attachments in the other direction,
 | |
|     # make sure signald is configured to use an absolute path as the data directory.
 | |
|     outgoing_attachment_dir: /signald/attachments
 | |
|     # Directory where signald stores avatars for groups.
 | |
|     avatar_dir: /signald/avatars
 | |
|     # Directory where signald stores auth data. Used to delete data when logging out.
 | |
|     data_dir: /signald/data
 | |
|     # Whether or not unknown signald accounts should be deleted when the bridge is started.
 | |
|     # When this is enabled, any UserInUse errors should be resolved by restarting the bridge.
 | |
|     delete_unknown_accounts_on_start: false
 | |
|     # Whether or not message attachments should be removed from disk after they're bridged.
 | |
|     remove_file_after_handling: true
 | |
| 
 | |
| # Bridge config
 | |
| bridge:
 | |
|     # Localpart template of MXIDs for Signal users.
 | |
|     # {userid} is replaced with an identifier for the Signal user.
 | |
|     username_template: "signal_{userid}"
 | |
|     # Displayname template for Signal users.
 | |
|     # {displayname} is replaced with the displayname of the Signal user, which is the first
 | |
|     # available variable in displayname_preference. The variables in displayname_preference
 | |
|     # can also be used here directly.
 | |
|     displayname_template: "{displayname} (Signal)"
 | |
|     # Possible values: disallow, allow, prefer
 | |
|     #
 | |
|     # Multi-user instances are recommended to disallow contact list names, as otherwise there can
 | |
|     # be conflicts between names from different users' contact lists.
 | |
|     contact_list_names: disallow
 | |
|     # Available variables: full_name, first_name, last_name, phone, uuid
 | |
|     displayname_preference:
 | |
|     - full_name
 | |
|     - phone
 | |
| 
 | |
|     # Whether or not to create portals for all groups on login/connect.
 | |
|     autocreate_group_portal: true
 | |
|     # Whether or not to create portals for all contacts on login/connect.
 | |
|     autocreate_contact_portal: false
 | |
|     # Whether or not to use /sync to get read receipts and typing notifications
 | |
|     # when double puppeting is enabled
 | |
|     sync_with_custom_puppets: true
 | |
|     # Whether or not to 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.
 | |
|     sync_direct_chat_list: false
 | |
|     # Allow using double puppeting from any server with a valid client .well-known file.
 | |
|     double_puppet_allow_discovery: false
 | |
|     # Servers to allow double puppeting from, even if double_puppet_allow_discovery is false.
 | |
|     double_puppet_server_map: {}
 | |
|     # 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.
 | |
|     # If using this for other servers than the bridge's server,
 | |
|     # you must also set the URL in the double_puppet_server_map.
 | |
|     login_shared_secret_map:
 | |
|         {{ matrix_mautrix_signal_homeserver_domain }}: {{ matrix_mautrix_signal_login_shared_secret|to_json }}
 | |
|     # Whether or not created rooms should have federation enabled.
 | |
|     # If false, created portal rooms will never be federated.
 | |
|     federate_rooms: true
 | |
|     # End-to-bridge encryption support options. You must install the e2be optional dependency for
 | |
|     # this to work. See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html
 | |
|     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 to Signal. This let's you check manually whether the bridge is receiving your
 | |
|     # messages.
 | |
|     # Note that this is not related to Signal delivery receipts.
 | |
|     delivery_receipts: false
 | |
|     # Whether or not delivery errors should be reported as messages in the Matrix room. (not yet implemented)
 | |
|     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
 | |
|     # Interval at which to resync contacts.
 | |
|     periodic_sync: 0
 | |
| 
 | |
|     # The prefix for commands. Only required in non-management rooms.
 | |
|     command_prefix: "!signal"
 | |
| 
 | |
|     # Permissions for using the bridge.
 | |
|     # Permitted values:
 | |
|     #      relay - Allowed to be relayed through the bridge, no access to commands.
 | |
|     #       user - Use the bridge with puppeting.
 | |
|     #      admin - Use and administrate the bridge.
 | |
|     # Permitted keys:
 | |
|     #        * - All Matrix users
 | |
|     #   domain - All users on that homeserver
 | |
|     #     mxid - Specific user
 | |
|     permissions: 
 | |
|         {{ matrix_mautrix_signal_bridge_permissions|from_yaml }}
 | |
| 
 | |
|     relay:
 | |
|         # Whether or not relay mode should be allowed. If allowed, `!signal set-relay` can be used to turn any
 | |
|         # authenticated user into a relaybot for that chat.
 | |
|         enabled: {{ matrix_mautrix_signal_relaybot_enabled }}
 | |
|         # The formats to use when sending messages to Signal via a relay user.
 | |
|         #
 | |
|         # Available variables:
 | |
|         #   $sender_displayname - The display name of the sender (e.g. Example User)
 | |
|         #   $sender_username    - The username (Matrix ID localpart) of the sender (e.g. exampleuser)
 | |
|         #   $sender_mxid        - The Matrix ID of the sender (e.g. @exampleuser:example.com)
 | |
|         #   $message            - The message content
 | |
|         message_formats:
 | |
|             m.text: '$sender_displayname: $message'
 | |
|             m.notice: '$sender_displayname: $message'
 | |
|             m.emote: '* $sender_displayname $message'
 | |
|             m.file: '$sender_displayname sent a file'
 | |
|             m.image: '$sender_displayname  sent an image'
 | |
|             m.audio: '$sender_displayname  sent an audio file'
 | |
|             m.video: '$sender_displayname  sent a video'
 | |
|             m.location: '$sender_displayname  sent a location'
 | |
| 
 | |
| 
 | |
| # 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:
 | |
|             (): mautrix_signal.util.ColorFormatter
 | |
|             format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
 | |
|         normal:
 | |
|             format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
 | |
|     handlers:
 | |
|         console:
 | |
|             class: logging.StreamHandler
 | |
|             formatter: colored
 | |
|     loggers:
 | |
|         mau:
 | |
|             level: {{ matrix_mautrix_signal_log_level }}
 | |
|         aiohttp:
 | |
|             level: INFO
 | |
|     root:
 | |
|         level: {{ matrix_mautrix_signal_log_level }}
 | |
|         handlers: [console]
 |