Commit Graph

1464 Commits

Author SHA1 Message Date
Slavi Pantaleev
fd43ed9a46
Merge pull request #3678 from luixxiul/fix
Update docs/configuring-playbook-bridge-appservice-discord.md
2024-10-25 11:07:38 +03:00
Suguru Hirahara
54e84c5c73
Update docs/configuring-playbook-bridge-appservice-discord.md
Fix a typo

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-25 16:27:18 +09:00
Slavi Pantaleev
f4c4930215 Fix some anchors on the MAS docs page 2024-10-25 09:37:03 +03:00
Slavi Pantaleev
17a20dca1e Make it more obvious that the Synapse OIDC config needs to go when using MAS 2024-10-25 09:34:41 +03:00
Slavi Pantaleev
dd29a85afe
Merge pull request #3676 from luixxiul/fix
Fix the title of docs/configuring-playbook-traefik.md
2024-10-25 09:18:43 +03:00
Suguru Hirahara
3e3ac11780
Fix the title of docs/configuring-playbook-traefik.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-24 20:24:47 +09:00
Aine
823a911361
Update configuring-playbook-synapse-admin.md - add community room link 2024-10-24 14:14:17 +03:00
Suguru Hirahara
6dff60e7a4
Fix capitalization: Rageshake → rageshake
Based on https://github.com/matrix-org/rageshake

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-24 18:02:19 +09:00
Suguru Hirahara
70e4320eda
Fix capitalization: Sliding Sync Proxy → Sliding Sync proxy
Based on MSC3575

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-24 18:02:08 +09:00
Suguru Hirahara
9f372d9058
Consistent usage of the words related to BorgBackup (Borg)
In order to avoid confusions between the name of the program itself (BorgBackup and Borg in short) and the backups managed by BorgBackup, the official full name should be preferred where possible, minding capitalization.

- Borg or borg → BorgBackup
- Borg backup(s) → BorgBackup (if it means the program) / backups with BorgBackup (if it means the backups managed by the program)

Based on https://www.borgbackup.org/

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-24 16:30:00 +09:00
Suguru Hirahara
4bdbbd9e94
docs/configuring-playbook-mautrix-bridges.md: fix periods
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-24 15:33:57 +09:00
Suguru Hirahara
a2790d11d5
Fix capitalization: Dimension Integration Manager → Dimension integration manager
Based on https://github.com/turt2live/matrix-dimension
> An open source integration manager for matrix clients, like Element.

"Dimension" is one of the integration managers, and it is not something like Dimension Integration Manager, which could be abbreviated as DIM.

Also:
- Replace "integrations manager" with "integration manager"
- Fix typos
- Remove a line break

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-24 12:58:34 +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
2f24299597
Update docs/configuring-playbook-bridge-appservice-slack.md: fix indentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-22 22:41:50 +09:00
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
Slavi Pantaleev
7a5a75ed03 Add a MAS note about the lack of encrypted appservices support
Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3658

Well, it's not a fix for "encrypted" Hookshot failing to work together with MAS, but..
It's not really an issue we can do anything about.
2024-10-22 10:15:21 +03:00
Slavi Pantaleev
66e2ef1f17
Merge pull request #3592 from ilterugur/patch-1
Update configuring-playbook-synapse-admin.md
2024-10-22 08:18:34 +03: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
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
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
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
Slavi Pantaleev
7b35beb843 Get rid of some double spaces 2024-10-21 14:31:53 +03:00
Slavi Pantaleev
802230a0ef
Merge pull request #3649 from luixxiul/fix
Update docs/configuring-playbook-bridge-heisenbridge.md: matrix_heisenbridge_owner domain and usage
2024-10-21 11:59:19 +03: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
Slavi Pantaleev
8f1262b596 Add matrix_authentication_service_syn2mas_process_extra_arguments to allow for --upstreamProviderMapping to be used with syn2mas
This makes it possible to migrate from Synapse when OIDC had been used
and the Synapse user database contains OIDC-sourced users.
2024-10-21 11:34:05 +03:00
Slavi Pantaleev
2afaeef6e3
Merge pull request #3648 from luixxiul/fix
Replace the default hostnames with others on documentation files for components about adjusting the service URL
2024-10-21 11:07:00 +03: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
Slavi Pantaleev
5431a34c69 Document matrix-user-creator suppression during MAS migration
Related to 3d7a926c19

Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3647
2024-10-21 10:57:05 +03:00
Slavi Pantaleev
3d7a926c19
Merge pull request #3646 from luixxiul/fix
Update documentation for components about adjusting the URL and the DNS records
2024-10-21 10:07:34 +03:00
Slavi Pantaleev
8f2e9e03a2 Use raw/endraw around templated strings in matrix_authentication_service_config_upstream_oauth2_providers sample config
Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3645
2024-10-21 09:13:14 +03: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
Slavi Pantaleev
9a8fd04432
Merge pull request #3640 from luixxiul/fix
Fix list numbering
2024-10-19 15:49:36 +03:00
Suguru Hirahara
398f4bbea5
Fix list numbering
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 21:34:00 +09:00
Slavi Pantaleev
8f16524789 Add support for Matrix Authentication Service
Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3108

Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3562
2024-10-19 14:43:34 +03: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
Slavi Pantaleev
0a675d3d91
Merge pull request #3638 from luixxiul/fix
Update docs/configuring-playbook-cactus-comments.md
2024-10-19 14:01:12 +03: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
Slavi Pantaleev
f91b716af3 Minor improvements to configuring-playbook-email.md 2024-10-19 12:28:03 +03: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
a933bdde75
Replace "Installation" with "Installing" on documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-19 12:22:25 +09:00
Slavi Pantaleev
e9998eaf87
Merge pull request #3634 from ginta1337/docs-own-ssl-certs-fix
Clarify documentation about own ssl certificate setup
2024-10-18 21:44:03 +03: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
ginta1337
7f7d19378c Clarify documentation about own ssl certificate setup 2024-10-18 21:28:50 +03: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
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
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
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
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
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
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
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