81 Commits

Author SHA1 Message Date
Suguru Hirahara
2180c58e62
Update docs for Prometheus: move the description for Docker image compatibility
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 02:00:19 +09:00
Suguru Hirahara
7907a649ee
Update docs/configuring-playbook-prometheus-grafana.md: remove variables for Sliding Sync proxy metrics
The component has been deprecated and it is not really sensible to keep those entries.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 02:00:06 +09:00
Suguru Hirahara
be02f12fed
Update docs/configuring-playbook-prometheus-grafana.md: fix the variables name
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 01:59:57 +09:00
Suguru Hirahara
e4d3b00927
Partially merge docs for prometheus-nginx-log-exporter to docs/configuring-playbook-prometheus-grafana.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-10 01:59:43 +09:00
Suguru Hirahara
2df8793a9c
Update docs/configuring-playbook-prometheus-grafana.md: add two entries for journalctl (matrix-prometheus-node-exporter and matrix-prometheus-postgres-exporter)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:24:41 +09:00
Suguru Hirahara
a67745b1fc
Remove the table for variables about the Postgres Server Exporter
As prometheus_postgres_exporter_container_labels_traefik_enabled is explained below, it is sensible to remove this duplicated entry in favor of it.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:59 +09:00
Suguru Hirahara
f4bc9c98ed
Update docs/configuring-playbook-prometheus-grafana.md: remove the note about the component disabled by default
It is not common to add a note about the component disabled by default.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:49 +09:00
Suguru Hirahara
a691306614
Update docs/configuring-playbook-prometheus-grafana.md: create sections for adjusting configurations of Prometheus and Grafanato decrease the section level
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:44 +09:00
Suguru Hirahara
00f3eda4dc
Update docs for Prometheus: adopt the common warning message
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:39 +09:00
Suguru Hirahara
152031bbae
Update docs/configuring-playbook-prometheus-grafana.md: move the security notice to the top
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:35 +09:00
Suguru Hirahara
4ecf6c2ba3
Update docs/configuring-playbook-prometheus-grafana.md: fix capitalization
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:30 +09:00
Suguru Hirahara
8b7b7732ef
Update docs/configuring-playbook-prometheus-grafana.md: move variables for setting username and password of Postgres exporter to the YAML block above
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:13:23 +09:00
Suguru Hirahara
505ff58292
Update docs/configuring-playbook-prometheus-grafana.md: tidy the section for Postgres exporter
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:11:58 +09:00
Suguru Hirahara
07cca8f4b4
Merge the document for instruction about metrics for Postgres to docs/configuring-playbook-prometheus-grafana.md to improve maintainability
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:05:25 +09:00
Suguru Hirahara
747e8ad589
Update docs/configuring-playbook-prometheus-grafana.md: switch the position of "Grafana" and "Prometheus" in the first sentence
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 18:04:49 +09:00
Suguru Hirahara
3d4c9bd0e9
Update docs/configuring-playbook-prometheus-grafana.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2025-02-09 13:35:58 +09:00
Suguru Hirahara
d7eb3f2765
Update docs/configuring-playbook-prometheus-grafana.md: move up the note about creating a CNAME record
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:31:55 +09:00
Suguru Hirahara
5e2bc80e6b
Update docs/configuring-playbook-prometheus-grafana.md: move down the optional configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:31:40 +09:00
Suguru Hirahara
2163daead2
Update docs/configuring-playbook-prometheus-grafana.md: move the comments out of the YAML block
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:31:29 +09:00
Suguru Hirahara
0154bc9931
Update docs/configuring-playbook-prometheus-grafana.md: move descriptions specific to each component to its subsection
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:30:12 +09:00
Suguru Hirahara
598cec4257
Update docs/configuring-playbook-prometheus-grafana.md: add the note label
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:30:03 +09:00
Suguru Hirahara
35b88ced00
Update docs/configuring-playbook-prometheus-grafana.md: split the table for the variables into two
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:29:52 +09:00
Suguru Hirahara
781f6d68a7
Update docs/configuring-playbook-prometheus-grafana.md: comment out grafana_anonymous_access as it is disabled by default
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:29:41 +09:00
Suguru Hirahara
8ecc83f2a9
Update docs/configuring-playbook-prometheus-grafana.md: copy the comments from the main.yml file
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:07:29 +09:00
Suguru Hirahara
15e889c21a
Update docs/configuring-playbook-prometheus-grafana.md: comment out lines for configs disabled by default
- Replace the comments for them

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:07:06 +09:00
Suguru Hirahara
8d52dc985a
Update docs/configuring-playbook-prometheus-grafana.md: add sections for Prometheus and Grafana
The introductions are copied from their configuration files.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:06:41 +09:00
Suguru Hirahara
19f17bb729
Update docs/configuring-playbook-prometheus-grafana.md: use the common placeholders
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:06:08 +09:00
Suguru Hirahara
1e7dba3737
Update docs/configuring-playbook-prometheus-grafana.md: move up the section for explanations about the variables
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-09 00:05:45 +09:00
Suguru Hirahara
1ddab52294
Update docs/configuring-playbook-prometheus-grafana.md: add periods to sentences
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-07 23:33:29 +09:00
Suguru Hirahara
63a6d7e73a
Update docs/configuring-playbook-prometheus-grafana.md: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-07 16:03:40 +09:00
Suguru Hirahara
049769514d
Update docs/configuring-playbook-prometheus-grafana.md: add the common section "Extending the configuration" for Prometheus
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-07 03:35:46 +09:00
Suguru Hirahara
b1856f0a22
Fix capitalization: nginx
It should be either NGINX or nginx, and this commit converts the string in uppercase to lowercase.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-05 13:11:04 +09:00
Suguru Hirahara
04b32af0c1
Update docs for DNS settings etc. (#3936)
* Update docs for DNS settings of the services which need its CNAME record by default

- Buscarron
- Go-NEB; fix a line on the instruction as well
- wsproxy
- Cinny
- Element Web
- Hydrogen
- SchildiChat Web
- Dimension
- Etherpad
- Jitsi
- ntfy
- Grafana
- rageshake
- Sygnal

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for DNS settings of the services which do not need its CNAME record by default

- matrix-alertmanager-receiver
- Honoroit
- maubot
- Heisenbridge
- Cactus Comments
- Matrix Authentication Service
- matrix-registration
- Sliding Sync proxy
- Synapse Admin
- synapse-usage-exporter

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for DNS settings: ma1sd

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for DNS settings: Email2Matrix

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for DNS settings: Postmoogle

Remove the table from configuring-dns.md altogether

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for Cinny and Dimension: adopt the common note

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-dns.md: add "Note" to the line on using Cloudflare DNS

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>
2025-01-15 09:22:00 +02:00
Suguru Hirahara
61ace3a063
Edit lines for vars.yml (#3933)
* Simplify paths to vars.yml if referred multiple times

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Fix the filename: vars.yaml → vars.yml

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>
2025-01-12 15:31:19 +02:00
Suguru Hirahara
e8548e0016
Mention how much "just install-all" is faster than "just setup-all"
This way, the "installing" sections would cover from beginners to advanced (professional) readers.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-02 20:00:58 +09:00
Suguru Hirahara
a31400ed4a
Adjust blank lines: add ones
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-02 03:14:48 +09:00
Suguru Hirahara
dd5881f2b8
Adjust blank lines: remove duplicated ones
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-12-02 03:14:39 +09:00
Suguru Hirahara
bc1849d7ff
Edit installing instructions (#3844)
* 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>
2024-12-01 17:04:54 +02:00
Suguru Hirahara
20c2aade3e
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 09:42:30 +02:00
Suguru Hirahara
3d47e0d69c
Synchronize document titles and links based on configuring-playbook.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-26 21:28:31 +09:00
Suguru Hirahara
6995f3990e
Edit line breaks in sentences and paragraphs
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-23 01:13:23 +09:00
Suguru Hirahara
fce459d04c
Replace the default hostnames with others on documentation files for components about adjusting the service URL
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 17:02:33 +09:00
Suguru Hirahara
e8c61b0a3c
Update lines for installing instruction: add anchor link to "adjusting DNS records" header
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 14:17:29 +09:00
Suguru Hirahara
81d7698944
Update documentation for components which require subdomain settings by default
This adopts the structure of docs/configuring-playbook-matrix-authentication-service.md which was recently created.

- …
- Adjusting the playbook configuration
  - …
  - Adjusting the (service name here) URL
  - …
- Adjusting DNS records
- Installing
- …

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 14:11:28 +09:00
Suguru Hirahara
1c5a8871d5
Replace <your-domain> with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:22 +09:00
Suguru Hirahara
90cfdabb2b
Replace DOMAIN with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:02 +09:00
Suguru Hirahara
174b18be9a
Fix capitalization: id → ID
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-16 02:25:03 +09:00
Slavi Pantaleev
020c66a2c1 Announce synapse-usage-exporter support
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3442
2024-07-25 20:30:41 +03:00
Kuchenmampfer
0f037bba48
Update broken link in configuring-playbook-prometheus-grafana.md 2024-07-07 16:44:19 +00:00
HarHarLinks
cc70ece99b sliding sync metrics support 2024-06-14 23:48:31 +02:00