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>
This commit intends to clarify what "short user ID" means by comparing it with ":matrix.example.com"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
The original ID (`@whatever_you_chose:example.com`) has not matched with the user ID which this page explained above on "Registering the bot user" section.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
- Use common expressions
- Remove a word puzzle for better l10n experience
- Remove a redundant whitespace character
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
We used to pass the shared secret for double-puppeting via a
`login_shared_secret` parameter, which doesn't seem to exist anymore.
The proper way to do it is via `login_shared_secret_map`.
The comments for `login_shared_secret_map` seem to indicate that it's
only usable with the shared-secret-auth password provider.
However, this bridge is based on mautrix-python (`>=0.20.5,<0.21`) as
per its `requirements.txt`
Support for double-puppeting via arbitrary access tokens landed in
mautrix-python 0.20.1 (6f25b62e80/CHANGELOG.md (L44-L53),)
so it should be possible to use appservice double-puppet.
Related to af04ca1238
A bunch of other parameters seem to have moved around as well.
This patch introduces some new Ansible variables for controlling
additional settings related to encryption, etc.
This way, the "installing" sections would cover from beginners to advanced (professional) readers.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Also: remove the redundant description about that difference from description about the "just" shortcuts.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all"
Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit installing instructions
- Move the anchor links to docs/just.md
- Add note about running "ensure-matrix-users-created" tags, if ansible-playbook's tags not "setup-all,ensure-matrix-users-created,start", ie. either "setup-all,start", "setup-email2matrix,start", "setup-aux-files,setup-corporal,start", or "setup-matrix-user-verification-service,start"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update descriptions about installation
- Introduce the most conservative and stable raw ansible-playbook command.
- Introduce the just commands on installing.md and maintenance-upgrading-services.md, not on quick-start.md, since it is too early for quick start guide readers who are just starting to climb learning curve to use the shortcuts.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-etherpad.md: remove the note about ensure-matrix-users-created
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>
As the SchildiChat Web docker image was updated with 14a3a01f43 thanks to Aine, the warning is no longer relevant. Note that though the package name says it is a test, it is a test release for SchildiChat Web, and the codebase is Element Web v1.11.86.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace installation command shortcut for the "just" program with the most conservative raw ansible-playbook command
This commit replaces installation command shortcut ("recipe") for the "just" program with the raw ansible-playbook command, so that the shortcut will be added to it later. The command is so conservative that failure of the command will mean something is clearly broken.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add comments about using setup-all instead of install-all
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add description about shortcut command with the "just" program to the ansible-playbook command with "setup-all" and "start" tags
It also explains difference between "just install-all" and "just setup-all" recipes. The explanation is based on docs/playbook-tags.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update raw ansible-playbook command to have it do what "just install-all" or "just setup-all" does
Since "just install-all" or "just setup-all" invokes "ensure-matrix-users-created" as well, it needs adding to the raw ansible-playbook command.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove "ensure-matrix-users-created" from the raw ansible-playbook command which does not need it
Also: update the "just" recipes accordingly. "just install-all" and "just setup-all" run "ensure-matrix-users-created" tag as well, therefore they need to be replaced with "run-tags" recipes to skip "ensure-matrix-users-created"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-etherpad.md: add ensure-matrix-users-created to the raw ansible-playbook
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add description about "ensure-matrix-users-created" and create a list with description about shortcut commands with "just"
This commit also fixes list item capitalization and punctuation.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add notes bullet lists
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-matrix-corporal.md and docs/configuring-playbook-email2matrix.md: adopt common instructions
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "run the installation command" with "run the playbook with tags"
Now that shortcut commands for the "just" program are displayed along with the existing "installation command", this commit replaces "run the installation command" with "run the playbook with tags" in order to prevent misunderstanding and confusion.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add notes about changing passwords of users specified on vars.yml
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-synapse-admin.md: add the playbook command and just recipes
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove redundant blank lines
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-alertmanager-receiver.md: remove the direction to proceed to Usage
Such a kind of direction is not used on other documentation, so it should be fine to just remove it.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/importing-synapse-media-store.md: code block for ansible-playbook
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-bridge-appservice-webhooks.md: apply the common documentation style
Since the bridge has been deprecated, this change is simply intended to improve styling and format of the article in case it will be used as a template of another bridge in a future.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-appservice-discord.md: apply the common documentation style
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-appservice-slack.md: apply the common documentation style
Also: move instruction to create Classic Slack application up as prerequisite
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-appservice-slack.md: emphasize the unavailability without a classic Slack application
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-bridge-appservice-kakaotalk.md: fix the header for adjusting the playbook configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Move sections "Set up Double Puppeting" under "Usage" as subsections for mautrix bridges and appservice kakaotalk
The changes in this commit reflect double puppeting configuration flow. Since the docs claim that double puppeting can be set up after enabling bridges by chatting with the bridge's bot, the explanation about double puppeting may well be placed under "Usage" as subsection.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove notes about setting up double puppeting manually
Since this method is explained after configuring bridges, those notes are no longer necessary.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs for mautrix and kakaotalk bridges: add prerequisite(s) section for instructing to install Appservice Double Puppet and/or Shared Secret Auth service
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "Enabling Appservice Double Puppet" with "This"
Enabling Appservice Double Puppet is contrasted with "Enabling double puppeting by enabling the Shared Secret Auth service", therefore it can be just called as "this" if Shared Secret Auth service is not mentioned below.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-beeper-linkedin.md: follow other instances
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add 💡 (Light Bulb: U+1F4A1) to the headings
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>
* Triple backticks with syntax highlighting: yml → yaml
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Triple backticks with syntax highlighting: yaml and sh
The strings "yml" were replaced with "yaml" as the latter is used more than the former.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Triple backticks with syntax highlighting: INI
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-jitsi.md: remove redundant white space characters after triple backticks
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/faq.md: replace instruction about restoration procedure with the anchor link to installing.md
Note the link to docs/maintenance-migrating.md is placed on the entry just above.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/faq.md: update description related to installation on matrix.example.com
Summary:
- Copy a paragraph from docs/howto-server-delegation.md
- Simplify instruction to install on matrix.example.com by removing repetitive description
- Remove duplicated description about server delegation
- Replace deprecated (or soon to be deprecated) services on configuration example for inventory/host_vars/matrix.example.com/vars.yml
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/faq.md: fix and simplify the answer to the reason why install your server at matrix.example.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>
Suguru Hirahara
Slavi Pantaleev
Suguru Hirahara