| @@ -17,9 +17,8 @@ To enable the bot, add the following configuration to your `inventory/host_vars/ | |||||
| ```yaml | ```yaml | ||||
| matrix_bot_matrix_registration_bot_enabled: true | matrix_bot_matrix_registration_bot_enabled: true | ||||
| #By default, the playbook will set use the bot with a username like | |||||
| ## this: `@bot.matrix-registration-bot:DOMAIN`. | |||||
| # To use a different username, uncomment & adjust the variable. | |||||
| # By default, the playbook will set use the bot with a username like this: `@bot.matrix-registration-bot:DOMAIN`. | |||||
| # To use a different username, uncomment & adjust the variable below: | |||||
| # matrix_bot_matrix_registration_bot_matrix_user_id_localpart: bot.matrix-registration-bot | # matrix_bot_matrix_registration_bot_matrix_user_id_localpart: bot.matrix-registration-bot | ||||
| # Generate a strong password here. Consider generating it with `pwgen -s 64 1` | # Generate a strong password here. Consider generating it with `pwgen -s 64 1` | ||||
| @@ -32,16 +31,11 @@ matrix_synapse_enable_registration: true | |||||
| matrix_synapse_registration_requires_token: true | matrix_synapse_registration_requires_token: true | ||||
| ``` | ``` | ||||
| The bot account will be automatically created. | |||||
| The bot account will be created automatically. | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command again: | |||||
| ``` | |||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | |||||
| ``` | |||||
| After configuring the playbook, re-run the [installation](installing.md) command again: `just install-all` or `just setup-all` | |||||
| ## Usage | ## Usage | ||||
| @@ -9,7 +9,7 @@ matrix_mautrix_signal_container_image_self_build_repo: "https://mau.dev/mautrix/ | |||||
| matrix_mautrix_signal_container_image_self_build_branch: "{{ 'main' if matrix_mautrix_signal_version == 'latest' else matrix_mautrix_signal_version }}" | matrix_mautrix_signal_container_image_self_build_branch: "{{ 'main' if matrix_mautrix_signal_version == 'latest' else matrix_mautrix_signal_version }}" | ||||
| # renovate: datasource=docker depName=dock.mau.dev/mautrix/signal | # renovate: datasource=docker depName=dock.mau.dev/mautrix/signal | ||||
| matrix_mautrix_signal_version: a91fc7028c54482ec6c581784d553199dfff93ff | |||||
| matrix_mautrix_signal_version: 959eb7eaf9eb648f97b8e85d7650ea87f2639cd1 | |||||
| # See: https://mau.dev/mautrix/signal/container_registry | # See: https://mau.dev/mautrix/signal/container_registry | ||||
| matrix_mautrix_signal_docker_image: "{{ matrix_mautrix_signal_docker_image_name_prefix }}mautrix/signal:{{ matrix_mautrix_signal_docker_image_tag }}" | matrix_mautrix_signal_docker_image: "{{ matrix_mautrix_signal_docker_image_name_prefix }}mautrix/signal:{{ matrix_mautrix_signal_docker_image_tag }}" | ||||
| @@ -204,3 +204,5 @@ matrix_mautrix_signal_bridge_personal_filtering_spaces: true | |||||
| # On conduit versions before 0.5.0 this option prevented users from joining spaces created by the bridge. | # On conduit versions before 0.5.0 this option prevented users from joining spaces created by the bridge. | ||||
| # Setting this to false fixed the issue. | # Setting this to false fixed the issue. | ||||
| matrix_mautrix_signal_bridge_restricted_rooms: true | matrix_mautrix_signal_bridge_restricted_rooms: true | ||||
| matrix_mautrix_signal_bridge_note_to_self_avatar: "mxc://maunium.net/REBIVrqjZwmaWpssCZpBlmlL" | |||||
| @@ -84,6 +84,10 @@ metrics: | |||||
| # IP and port where the metrics listener should be. The path is always /metrics | # IP and port where the metrics listener should be. The path is always /metrics | ||||
| listen: 0.0.0.0:8000 | listen: 0.0.0.0:8000 | ||||
| signal: | |||||
| # Default device name that shows up in the Signal app. | |||||
| device_name: mautrix-signal | |||||
| # Bridge config | # Bridge config | ||||
| bridge: | bridge: | ||||
| # Localpart template of MXIDs for Signal users. | # Localpart template of MXIDs for Signal users. | ||||
| @@ -105,6 +109,10 @@ bridge: | |||||
| private_chat_portal_meta: default | private_chat_portal_meta: default | ||||
| # Should avatars from the user's contact list be used? This is not safe on multi-user instances. | # Should avatars from the user's contact list be used? This is not safe on multi-user instances. | ||||
| use_contact_avatars: false | use_contact_avatars: false | ||||
| # Should the Signal user's phone number be included in the room topic in private chat portal rooms? | |||||
| number_in_topic: true | |||||
| # Avatar image for the Note to Self room. | |||||
| note_to_self_avatar: {{ matrix_mautrix_signal_bridge_note_to_self_avatar | to_json }} | |||||
| portal_message_buffer: 128 | portal_message_buffer: 128 | ||||
| @@ -114,6 +122,8 @@ bridge: | |||||
| personal_filtering_spaces: {{ matrix_mautrix_signal_bridge_personal_filtering_spaces | to_json }} | personal_filtering_spaces: {{ matrix_mautrix_signal_bridge_personal_filtering_spaces | to_json }} | ||||
| # Should the bridge send a read receipt from the bridge bot when a message has been sent to Signal? | # Should the bridge send a read receipt from the bridge bot when a message has been sent to Signal? | ||||
| delivery_receipts: false | delivery_receipts: false | ||||
| # Should Matrix m.notice-type messages be bridged? | |||||
| bridge_notices: true | |||||
| # Whether the bridge should send the message status as a custom com.beeper.message_send_status event. | # Whether the bridge should send the message status as a custom com.beeper.message_send_status event. | ||||
| message_status_events: false | message_status_events: false | ||||
| # Whether the bridge should send error notices via m.notice events when a message fails to bridge. | # Whether the bridge should send error notices via m.notice events when a message fails to bridge. | ||||