* 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>
This is related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3831
It:
- adds some missing variables
- version variable to branch variable conversion
While it improves the situation, it still doesn't result in a working
self-building feature, because:
- cloning a repository containing submodules requires special care,
as described here
(c03ef20e5d/README.md (initial-build-setup))
- we likely better clone a specific repository version from the very beginning, instead of trying to change subsequently (and having to re-initilize submodules)
though that's very different than what we're doing elsewhere and is likely very wasteful
- we can't just build a `Dockerfile`, we need to invoke `make setup` (`./setup.sh`)
- it's likely that the `docker-src` directory is not reusable across
versions or may require special handling to clean up files, etc.
* 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>
* Update docs/README.md: add "installation guides" section
Add the emoji to the link to quick-start.md only and not to full installation guide to emphasize the quick start guide
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: move a link to faq.md down
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: add "Maintenance" section
Add a hint to join the support room under "Maintenance" header.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: create the "configuration options" section and add a note
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: sort list items
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: emphasize the anchor link to faq.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: add other anchor links to the "other documentation pages" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: add the emoji ℹ️ before the anchor link to faq.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: explanation about FAQ
Remove the hint to check the installation guides as links to them are listed on top of this page.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/README.md: update text of the anchor link to docs/getting-the-playbook.md
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>
* Edit docs/maintenance-migrating.md: replace the numbering list with sections for each item
Also: add an ansible-playbook command with the stop tag as the main command to stop the Matrix services.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: move the note under the header
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/maintenance-migrating.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: add a section "checking if services work"
The commit does not include the detail as having another similar section increases doubles effort to maintain them and increases possibility of causing discrepancy.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: add a note about joining the support room on Matrix
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: replace hosts with inventory/hosts
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: instruction to run ansible-playbook commands locally
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/maintenance-migrating.md: edit the check section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/maintenance-migrating.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Update docs/maintenance-migrating.md: reflect the review and edit a note for creating a temporary account on another server
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Minor rewording in maintenance-migrating.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>
This is a follow-up to 5483925ee4.
Since any-of-issue/pr-labels overrides any-of-labels, the values specified by the latter need to be specified by the former.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Without this option, stale counters for each PR keep restarting whenever any update occurs or a comment is added to them. Since the counters for PR are set to 365 days, ignore-pr-updates should help us to get rid of zombie PRs (which are kept open by bumps).
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
