Commit Graph
100 Commits
Author SHA1 Message Date
Suguru Hirahara a124461ba6 Update docs/configuring-playbook-bridge-mautrix-discord.md and docs/configuring-playbook-bridge-mautrix-facebook.md
- Fix listing: docs/configuring-playbook-bridge-mautrix-discord.md
- Add parentheses: docs/configuring-playbook-bridge-mautrix-facebook.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-22 21:59:38 +09:00
Suguru Hirahara aa7a3b477a Update docs/configuring-playbook-bot-postmoogle.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-22 20:35:43 +09:00
Suguru Hirahara 917a631984 Remove the "installation is disabled by default" from documentation files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-22 19:19:34 +09:00
Suguru Hirahara cfed646149 Update docs/registering-users.md: use common expressions for playbook configuration and installation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-22 00:01:46 +09:00
Suguru Hirahara 159daa7466 Use a room alias on Matrix Specification
"#matrix:example.org" is used as an example of a room alias on https://spec.matrix.org/v1.12/#room-aliases

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 22:00:32 +09:00
Suguru Hirahara da07b302fa Replace !anotherRoom with !aaabaa
!aaabaa is used as an example of a room ID on https://spec.matrix.org/v1.12/#room-aliases

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:48:46 +09:00
Suguru Hirahara 5fc2e2f1f9 Replace !anotherroom with !anotherRoom
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:48:29 +09:00
Suguru Hirahara 0593edbb1a Replace !example:example.org and !example:example.com with !qporfwt:example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:48:09 +09:00
Suguru Hirahara aaa6335053 Replace !someRoom with !qporfwt
!qporfwt is used as an example of a room ID on https://spec.matrix.org/v1.12/#room-structure

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:47:52 +09:00
Suguru Hirahara 1e8030810f Update internal room ID: !someRoom
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:47:02 +09:00
Suguru Hirahara d152bbcd0c Replace :matrix.org with :example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:43:02 +09:00
Suguru Hirahara 65967dd52e Replace :SERVER with :example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:42:56 +09:00
Suguru Hirahara ec1b18cf6e Fix internal room ID: id → example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:42:35 +09:00
Suguru Hirahara ebd4463654 Fix internal room ID: room.id → example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 21:42:06 +09:00
Suguru Hirahara 81a4ef54aa Update docs/configuring-dns: fix an incorrect anchor link
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 20:45:02 +09:00
Suguru Hirahara 70411706a9 Update docs/configuring-playbook-bridge-heisenbridge.md: matrix_heisenbridge_owner domain and usage
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 17:52:57 +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 a6fa33e16c Update docs/configuring-playbook-alertmanager-receiver.md: fix anchor links
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 14:17: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 c892971e89 Update documentation for components which do not 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:17:24 +09:00
Suguru Hirahara ea6e879487 Update docs/configuring-dns.md: add an entry for Rageshake
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-21 14:17:18 +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 3e95e6d2f6 Add detail about setting up schildichat subdomain on docs/configuring-dns.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-20 02:13:06 +09:00
Suguru Hirahara e3e16259c0 Update docs/configuring-playbook-conduit.md and docs/configuring-playbook-dendrite.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 23:09:38 +09:00
Suguru Hirahara 398f4bbea5 Fix list numbering
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 21:34:00 +09:00
Suguru Hirahara c1cffe70ed Update docs/configuring-playbook-cactus-comments.md: fix the example domain
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 20:22:13 +09:00
Suguru Hirahara 95f541b86c Update docs/configuring-playbook-cactus-comments.md: add a section for embedding Cactus Comments
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 19:37:09 +09:00
Suguru Hirahara 015ad80e62 Update docs/configuring-playbook-cactus-comments.md: use the common expression for configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 19:26:44 +09:00
Suguru Hirahara c33a4225ba Update docs/configuring-playbook-client-*: line breaks
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 16:56:36 +09:00
Suguru Hirahara d8a638f518 Update roles/custom/matrix-bridge-mx-puppet-*: fix domain names and use same comments
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 14:03:44 +09:00
Suguru Hirahara a933bdde75 Replace "Installation" with "Installing" on documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 12:22:25 +09:00
Suguru Hirahara 4db1d6f874 Update docs/configuring-playbook-bridge-mx* - remove line breaks inside a sentence
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 03:29:46 +09:00
Suguru Hirahara 55fcaac1f1 Fix capitalization: matrix → Matrix
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 23:35:10 +09:00
Suguru Hirahara fa1d92f85d Update docs/configuring-playbook.md
- Mention "base domain"
- Fix list numbering
- Add a blank line

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 21:30:58 +09:00
Suguru Hirahara 49f7fd96c9 Fix docs/configuring-well-known.md and add a comment
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 17:01:37 +09:00
Suguru Hirahara 26503464c6 Update examples/vars.yml: update a comment to sync with roles/custom/matrix-base/defaults/main.yml
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 16:36:25 +09:00
Suguru Hirahara d997ac6e34 Update docs/configuring-playbook-traefik.md: fix the incorrect hostname
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 16:23:31 +09:00
Suguru Hirahara 2b102851e2 Update docs/configuring-playbook-traefik.md: use a different hostname
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 16:22:10 +09:00
Suguru Hirahara 309b91163a Update docs/configuring-playbook-email.md: fix default email sender specified by exim_relay_sender_address
exim_relay_sender_address consists of exim_relay_hostname, which by default is equal to matrix_server_fqn_matrix, whose default value is matrix.example.com

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 16:15:09 +09:00
Suguru Hirahara 4a375be6a8 Replace matrix.domain with matrix.example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 12:15:53 +09:00
Suguru Hirahara 54f7dd587a Replace second-example.com and third-example.com with example.net and example.org, respectively
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:03:27 +09:00
Suguru Hirahara b392b544da Replace another.com with example.net
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:03:23 +09:00
Suguru Hirahara c73800b6bc Replace matrix-example.com-media-store with matrix-example-media-store
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:03:18 +09:00
Suguru Hirahara 951cdba49b Replace <server-name> with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:03:14 +09:00
Suguru Hirahara 7aab3a4f83 Replace <host> with matrix.example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:03:08 +09:00
Suguru Hirahara 5153c9a6c4 Replace <domain-name> with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:03:04 +09:00
Suguru Hirahara 28c28e1e00 Replace <domain> with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:59 +09:00
Suguru Hirahara e42e8aaf83 Replace <your-domain-name> with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:54 +09:00
Suguru Hirahara 6c4eeda748 Replace example.example.com with matrix.example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:50 +09:00
Suguru Hirahara 9089963fa8 Replace server.com with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:45 +09:00
Suguru Hirahara ee55138f57 Replace your-homeserver.com with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:41 +09:00
Suguru Hirahara ff4155e033 Replace yourserver.com with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:31 +09:00
Suguru Hirahara 3fb2752714 Replace (your.)server.name with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:27 +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 faa441029c Replace <matrix-domain> with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:18 +09:00
Suguru Hirahara d45657df70 Replace YOUR_BARE_DOMAIN_NAME_HERE with example.com
Remove an explanation about example as it is self-explanatory

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:13 +09:00
Suguru Hirahara f9cff0ff47 Replace MY.example.com with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 04:02:09 +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 95ab7fabd0 Edit user identifier example: example.com → {{ matrix_domain }}
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:30:41 +09:00
Suguru Hirahara 02e0c2c3e0 Edit user identifier example: DOMAIN → {{ matrix_domain }}
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:30:03 +09:00
Suguru Hirahara fe238474a5 Replace matrix-homeserver-domain with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:29:50 +09:00
Suguru Hirahara b2d840482a Replace domain names on roles/custom/matrix-bot-matrix-reminder-bot/templates/config.yaml.j2
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:29:23 +09:00
Suguru Hirahara d218e93155 Replace example.tld with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:29:05 +09:00
Suguru Hirahara 288a711af6 Replace domain.tld with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:28:47 +09:00
Suguru Hirahara ef8cf740a1 Replace mydomain.tld with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:28:24 +09:00
Suguru Hirahara e54d66053c Replace <domain.name> with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:28:14 +09:00
Suguru Hirahara 532babc55b Replace yourdomain.com with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:28:02 +09:00
Suguru Hirahara c02aba2724 Replace mydomain.com with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:27:40 +09:00
Suguru Hirahara 7779b747ea Edit user identifier example (domain.com → example.com)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:27:18 +09:00
Suguru Hirahara 59dd889671 Replace <example.com> with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:26:47 +09:00
Suguru Hirahara 0261e247e3 Replace YOUR_DOMAIN with example.com
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 00:26:23 +09:00
Suguru Hirahara 0eb53a0e77 Update docs/configuring-playbook-cactus-comments.md: add line breaks
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 20:40:52 +09:00
Suguru Hirahara 0b688eb949 Update docs/configuring-playbook-external-postgres.md: minor changes
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 20:33:48 +09:00
Suguru Hirahara bf8bbdd5ba Remove whitespace characters from the comment block
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 20:32:46 +09:00
Suguru Hirahara e961e1b43d Update Email2Matrix documentation and its default configuration file
- Sync list of mailbox to Matrix mappings
- Add explanation for each variable

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 20:23:15 +09:00
Suguru Hirahara b9ba9a8ba3 Move colons outside of asterisks
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 18:29:47 +09:00
Suguru Hirahara b7b2fe7fed Use a common expression to suggest to skip the document
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 18:10:24 +09:00
Suguru Hirahara 3d7cef0490 Update docs/configuring-playbook-bot-postmoogle.md: add "bots" to the comment
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 15:22:17 +09:00
Suguru Hirahara a874d5f918 Update docs/configuring-playbook-external-postgres.md: remove a duplicate sentence
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 15:01:43 +09:00
Suguru Hirahara 9b76a86daf Use a common expression for password setting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 14:22:45 +09:00
Suguru Hirahara 9ff0a5c34f Use a common expression for suggesting to uncomment and adjust configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 03:53:43 +09:00
Suguru Hirahara 844d8ef4c3 Fix capitalization: etherpad → Etherpad
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 02:25:35 +09:00
Suguru Hirahara fbd4a48709 Update docs/configuring-playbook-etherpad.md: add line breaks
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 02:25:26 +09:00
Suguru Hirahara 2f9403baee Update docs/configuring-playbook-etherpad.md: edit comment block for configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-17 02:24:42 +09:00
Suguru Hirahara 08dfa094ea Update docs/configuring-playbook-email2matrix.md: adjust line breaks
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-16 02:53:22 +09:00
Suguru Hirahara c5646712b6 Update docs/configuring-playbook-email2matrix.md: fix the anchor link text and add a section for installing
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-16 02:53:14 +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
Suguru Hirahara ac90870e30 Fix capitalization: room id → room ID
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-16 02:24:52 +09:00
Suguru Hirahara f2a5b8595e Update docs/configuring-playbook-bridge-appservice-slack.md: use a common expression for adding configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-16 01:04:15 +09:00
Suguru Hirahara 45abdaac01 Update docs/configuring-playbook-bridge-appservice-slack.md: fix capitalization
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-16 01:04:10 +09:00
Suguru Hirahara bc579cd3ba Update docs/configuring-playbook-bridge-appservice-slack.md: fix list numbering 2024-10-16 01:04:05 +09:00
Suguru Hirahara c7e347468f Update docs/configuring-playbook-bridge-appservice-slack.md: fix line breaks
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-16 01:04:01 +09:00
Suguru Hirahara 9a75758bbe Update docs/configuring-playbook-bridge-appservice-slack.md: fix indentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-16 01:03:50 +09:00
Suguru Hirahara a8ab53c149 Use double wildcards for 'Note'
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-15 03:05:26 +09:00
Suguru Hirahara ba9aeb7c9f Consistent capitalization: NOTE → Note
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-15 02:58:40 +09:00
Suguru Hirahara 789bf88b92 Make "Note" consistent: wrap with wildcards
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-15 02:48:46 +09:00
Suguru Hirahara 03ae2d11f8 Update docs/configuring-playbook-bridge-hookshot.md
- Wrap "Note" with wildcards
- Fix colon placement
- Fix typos
- Remove an unclosed parenthesis

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-14 22:10:03 +09:00
Suguru Hirahara 2a443046c8 Fix capitalization: schildichat → SchildiChat
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-14 15:59:16 +09:00
Suguru Hirahara 036c949577 Update docs/configuring-playbook-bot-matrix-registration-bot.md
- Use a common expression for a comment
- Use a common expression for usage instruction
- Fix typos

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-14 14:27:54 +09:00
Suguru Hirahara 435da333a9 Remove 'again'
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-13 11:50:04 +09:00