For WhatsApp the default relay mode is used and the description for it is available on the common guide for configuring mautrix bridges.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-mautrix-bridges.md: edit the section "extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-mautrix-bridges.md: edit section headers
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-mautrix-bridges.md: edit the section "Control the logging level"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-mautrix-bridges.md: replace examples for service name
- Remove hangout, which has been shut down and whose role is soon to be removed from the playbook
- Add a note about the Mautrix Meta bridge
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-mautrix-bridges.md: add descriptions to each section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-mautrix-bridges.md: move the section "Set up Double Puppeting" to "Usage"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename docs/configuring-playbook-mautrix-bridges.md to docs/configuring-playbook-bridge-mautrix-bridges.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: edit an instruction
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: add the manual step for setting up Double Puppetting
Based on other documents for mautrix bridges like docs/configuring-playbook-bridge-mautrix-discord.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: add a note about bridges' incompatibility with Appservice Double Puppet
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: adopt the description on docs/configuring-playbook-appservice-double-puppet.md
Make it clear that Double Puppetting with the other methods than the appservice one has been superseded. See: https://docs.mau.fi/bridges/general/double-puppeting.html#automatically
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: add "recommended" label to the first method of setting up Double Puppeting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: add anchor links to the official documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: add descriptions about configuring bridge permissions
Partially based on docs/configuring-playbook-bridge-mautrix-meta-instagram.md etc.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: add description about the relaybot
Based on:
- the official documentation: https://docs.mau.fi/bridges/general/relay-mode.html
- docs/configuring-playbook-bridge-mautrix-whatsapp.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: remove a duplicated anchor link
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook.md: add an anchor link to configuring-playbook-bridge-mautrix-bridges.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: edit a sentence
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-bridges.md: reflect the review
See https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3913#discussion_r1903215741
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Add a warning sign to "Warning" labels
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-matrix-registration.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/maintenance-and-troubleshooting.md: remove a section for ma1sd
As the project has not updated since several years, it does not seem to be reasonable to pick it up specially on the document.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Common header for sections about adjusting the playbook configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-dendrite.md: fix links to dendrite.yaml.j2
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-signal.md: remove a note added by a commit to remove signalgo
The note has been added with 2f6525ccb3666e0ec8f295e8eeffd78bac15a23e, apparently copied from docs/configuring-playbook-bridge-mautrix-signalgo.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-wsproxy.md: fix the anchor link text to mautrix-imessage documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-etherpad.md: add a note about the component being managed externally
Refer docs/configuring-playbook-backup-borg.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-jitsi.md: use the common label for warning messages
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-ldap-auth.md: unrecommend using ma1sd for authentication
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-double-puppet.md: remove a duplicate anchor link
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs for old mautrix bridges for Facebook and Instagram: remove anchor links to the deleted files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-wechat.md: use common descriptions
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-matrix-bridge-sms.md: create a section for the prerequisite
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/maintenance-and-troubleshooting.md: use the common header text
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Use common descriptions for adding the configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-mautrix-telegram.md: small edits
- Add a section for a Telegram API key
- Add a section for instruction about Appservice Double Puppet or Shared Secret Auth
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs for Draupnir and Mjolnir: replace colons with periods
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-rageshake.md: adopt the common instruction
Based on docs/configuring-playbook-sygnal.md regarding the notification about necessity of the service.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a note about the components managed externally
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: adopt the common section for controlling the logging level
Based on:
- docs/configuring-playbook-bridge-mautrix-bridges.md
- roles/custom/matrix-user-verification-service/defaults/main.yml
Other minor changes:
- Add an upper section "troubleshooting" for "TLS Certificate Checking"
- Use backticks
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Update docs/configuring-playbook-user-verification-service.md: add the common introduction
Based on docs/configuring-playbook-dimension.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: use a common placeholder for an access token
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: use a common header for adjusting the playbook configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: instruction for registering a dedicated user
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: use abbreviation
See the line 3.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: move the section for obtaining an access token up
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: remove a redundant paragraph about necessity of token
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs: notes on port 8448 for federation, etc.
- Create sections for the instruction about opening Matrix Federation port
- Remove unmaintained components which this project does not recommend to install from examples about opening the port on docs/prerequisites.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: create a section for explaining the function of the component
Based on docs/configuring-playbook-prometheus-grafana.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: add a note about creating user as an admin
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-user-verification-service.md: merge the section "Configuration" and edit it
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Apply suggestions from code review
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
Based on docs/configuring-playbook-dimension.md and docs/configuring-playbook-bot-go-neb.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
- Register a dedicated Matrix user (optional)
- Obtain an access token
Since Dimension has been archived, this is purely for possible use as a template of another component.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
- Add "To use the bot" if it does not exist: adopt the format of the docs for bridges
- Add "Prerequisites" section if an API key or user account is required
- Use the common instruction for getting an access token
- Replace "Get" with "Obtain" about getting keys or access tokens
- Replace placeholders for access tokens on docs/configuring-playbook-bot-go.neb.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit replaces instructions to create passwords, passphrases, or secrets with common ones.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
The common pattern is "Send `.*?` to the bot (in the room) to see the available commands." If the descripions are about a bot being invited to a certain existing room or room which is not DM, then "in the room" is inserted among them.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3841
Most of the preparation for this was done by Suguru Hirahara (https://github.com/luixxiul).
I've merely reorganized/polished the scripts and instructions in the `i18n/` directory.
While translations can happen even now, more work is necessary to
- make the translation flow better (integrating Weblate), etc.
- restore the Github Actions workflows that Suguru Hirahara had already developed to
adapt them to our new workflow
Usage of matrix_alertmanager_receiver_config_matrix_room_mapping is decribed below in the "Adjusting the playbook configuration" much more nicely.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: fix sections title
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: merge configuration sections
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: small edits
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: remove a note abour Pantalaimon's unavailability
Pantalaimon can be installed and it has become available for matrix-bot-draupnir and matrix-bot-mjolnir already.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: edit instruction of setting an alias to the management room
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md: remove 'c.' from the section title
The section is not related to choosing E2EE support.
Also: replace the instruction to go to the section with the anchor link.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md: create a section for common configs
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: create "Extending the configuration" sections
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md: create the "End-to-End Encryption support" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-mjolnir: adjust the section hierarchy
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: replace numbering
This is a follow-up to e5ab17cafd.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: create "Prerequisites" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: emphasize necessity of disabling rate limit
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: instruction for discharging rate limit on Synapse
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: edit the placeholder for matrix_bot_draupnir_pantalaimon_password and matrix_bot_mjolnir_pantalaimon_password
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update draupnir and mjolnir docs: add an anchor link to "Configuration with E2EE support"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md: move the "Abuse Reports" section above
Also: use "pollReports: true" as an example for extending the configuration.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md: small edits
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: use a common expression
cf. docs/configuring-playbook-alertmanager-receiver.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: integrate the description for installation by Draupnir into our description
Check the original one: 120b37f3ea
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: fix a typo
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
- Replace links to the documentation with ones to projects' README files, if these have been linked to the project directly
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
The original ID (`@example:example.com`) has not matched with the user IDs which those pages explained on "Registering the bot account" section.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
"To use the bridge, you need to start a chat with …" is well used among the documentation.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
As using `@alice` and `@bob` on this context is confusing, this commit replaces them with `@email2matrix1` and `@email2matrix2`, respectively.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Suguru Hirahara
Suguru Hirahara
Slavi Pantaleev