matrix-docker-ansible-deploy/docs/maintenance-checking-services.md

# Checking if services work

This playbook can perform a check to ensure that you've configured things correctly and that services are running.

To perform the check, run:

```sh
ansible-playbook -i inventory/hosts setup.yml --tags=self-check
```

The shortcut command with `just` program is also available: `just run-tags self-check`

If it's all green, everything is probably running correctly.

Besides this self-check, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain.
Add self-check command 2018-10-21 09:58:25 +00:00			`# Checking if services work`

			`This playbook can perform a check to ensure that you've configured things correctly and that services are running.`

			`To perform the check, run:`

Update triple backticks with syntax highlighting (#3832) * 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> 2024-11-28 09:33:56 +00:00			```sh
Add self-check command 2018-10-21 09:58:25 +00:00			`ansible-playbook -i inventory/hosts setup.yml --tags=self-check`
			```

Edit descriptions about installation of components (#3842) * 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> 2024-12-01 07:42:30 +00:00			The shortcut command with `just` program is also available: `just run-tags self-check`

Add self-check command 2018-10-21 09:58:25 +00:00			`If it's all green, everything is probably running correctly.`

Add "Quick start" guide (#3801) * Add docs/quick-start.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add description about keeping the playbook and services up-to-date Also: move descriptions about difference between the playbook tags (setup-all and install-all) and about the just "recipe" from installing.md to maintenance-upgrading-services.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Replace <your-username> with YOUR_USERNAME_HERE This is a common expression and should avoid misunderstanding that `<` and `>` would need to be included Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Replace <your-password> with YOUR_PASSWORD_HERE Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Change the link to 'Quick start' on the breadcrumbs from README.md to quick-start.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add a link to quick-start.md on the "Getting started" section Since I am not quite sure whether the link to prerequisites.md should be replaced in favor of this link, this commit leaves it as it is for now. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add a link to quick-start.md on docs/README.md Since I am not quite sure whether the link to prerequisites.md should be replaced in favor of this link, this commit leaves it as it is for now. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add note about using "example.com" as an example domain Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Remove backticks from command examples to register a user Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Apply suggestions from code review Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Improve notes for instruction to create a user account Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add details about delegation to installing.md and quick-start.md Some information is omitted on quick-start.md in favor of installing.md to keep the quick start guide simple. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/quick-start.md: add the breadcrumb header Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/quick-start.md: run the setup command with install-all by default Refer docs/maintenance-upgrading-services.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Revert "Update docs/quick-start.md: add the breadcrumb header" This reverts commit 9a6e1cf14c7638953fc8fbb8b487ea0afd0a41ad. As the quick start guide is standalone. * Update docs/quick-start.md: add headers inside the install section These headers should make it perfectly clear that there are two steps to be done to install with the playbook Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update quick-start.md * Update docs/registering-users.md: notes for manual user registeration Copy the same notes from quick-start.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Reword some things in quick start * Add alternative to `just roles` * Update docs/configuring-dns.md: sync with docs/quick-start.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/quick-start.md: add a link to docs/registering-users.md for an instruction to add user accounts Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/registering-users.md and docs/updating-users-passwords.md: remove "your" from username and password placeholders These documentations, unlike docs/installing.md and docs/quick-start.md, describe how to handle users (registering them or changing their passwords), some of whom are yours, while others are not. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/installing.md: add "your" to make it clear that it is "your" account that is going to be created Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/installing.md and docs/quick-start.md: mention "make roles" This commit adds mentions to "make roles" and a note about the preference of ansible-playbook commands over the just "recipes". quick-start.md intends to be referred by those who have never used the playbook to set up a server, so it is safer to regard that it is not clear to them what exactly the just "recipes" are made of, ie. it takes some time and experience until someone understands simplicity of them. For beginners, I believe that we should prefer the basics over simplicity, from the educational point of view. If someone feels tired of using the same command repetitively, then the person will have been already well accustomed to the way how the playbook works and how the server is supposed to be maintained, and the person is "qualified" to use the just "recipes", and should be able to use them with confidence, distinguishing the playbook tags from the "recipes", for example, from "just install-all" and "ansible-playbook -i inventory/hosts setup.yml --tags=install-all". Such level of familiarity and experience should not be expected on the quick start guide. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update instructions to update Ansible roles Also: move the detailed explanation about "just roles" from installing.md to maintenance-upgrading-services.md TBD: create a dedicated documentation for the "just" program and the concept of its "recipe" (shortcut of commands) Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add a note about cases to create multiple accounts/users Since one of the quick start guide's goals is to set up an own user account, this commit adds the note about creating multiple accounts/users to installing.md and registering-users.md only. It should be fine as registering-users.md is linked from quick-start.md Also: - On installing.md and quick-start.md, change instruction from what encourages to select "admin=yes" or "admin=no" to what encourages to use "admin=yes", since your user account will be the sole user on the server, as long as you set up the server by following the documentation - Remove the link to registering-users.md from quick-start.md as the documentation is already linked above, under the header of the section - Sync docs/installing.md with other documentation Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Remove a line about setting "admin=yes" to reduce the amount of information Because quick-start.md is getting longer with much information, it removes the note in favor of the linked registering-users.md documentation. The note is available on installing.md as well, and details about adding user accounts for other people can (and should) be checked on those documentations. Also, this commit edits lines above these notes to make it clear that your user account will be an administrator of the server. With this commit, the amount of the information about adding user accounts will be: registering-users.md > installing.md > quick-start.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Fix a broken anchor link on docs/installing.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Replace repetitive information about upgrading with an anchor link to docs/maintenance-upgrading-services.md Because details to update/upgrade the Matrix services is not necessary for quick start and the amount of information should be reduced from the viewpoint of maintainability, this commit removes details to update/upgrade from quick-start.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/quick-start.md: add a note about keeping it tidy and simple Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/maintenance-checking-services.md and docs/quick-start.md: add instruction to use federation tester against the base domain Per Slavi's suggestion. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/installing.md and docs/quick-start.md: replace commands to finalize the installation Per Slavi's suggestion. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Clarify install-matrix-static-files to avoid confusion with install-all; Minor consistency improvements --------- 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> 2024-11-23 07:59:29 +00:00			Besides this self-check, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain.