Commit Graph

1596 Commits

Author SHA1 Message Date
Mitja Jež
d817a923a3
Update installing.md
I believe this is typo.
2024-11-04 18:21:46 +01:00
Suguru Hirahara
4bd511819f
Update docs/installing.md: add a note to avoid running the just recipe install-all, instead of ansible-playbook with install-all tag
The note is for those who are not familiar with the playbook's tag and its just recipe.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-04 23:00:25 +09:00
Slavi Pantaleev
71b00a817d
Merge pull request #3738 from luixxiul/fix
Update documentation related to FAQ
2024-11-04 10:47:23 +02:00
Suguru Hirahara
ae4dd1ea3a
Update docs/faq.md: fix headings level
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-04 16:27:39 +09:00
Slavi Pantaleev
970ae997b6
Merge pull request #3736 from ikkemaniac/patch-1
improve readability configuring-dns.md
2024-11-04 08:31:27 +02:00
Suguru Hirahara
7b9aaceb7e
Update README.md and docs/container-images.md: move "synapse-simple-antispam" to Authentication, following docs/configuring-playbook.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-04 13:11:37 +09:00
Suguru Hirahara
c8ee67aa3b
Update README.md and docs/container-images.md: move up Exim as default service
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-04 13:10:26 +09:00
ikkemaniac
7864a75607
improve readability configuring-dns.md 2024-11-03 21:08:10 +01:00
Suguru Hirahara
68b8f1137f
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section
These sentences are copied from README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:43:06 +09:00
Suguru Hirahara
16104b6e57
Update docs/configuring-playbook.md: move entries to "Other specialized services" section
These entries are ones categorized under "Misc" section on README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:41:59 +09:00
Suguru Hirahara
69273b30e4
Update docs/configuring-playbook.md: create "Administration" section
Reorganize "Additional useful services" section and "Other specialized services" section

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:39:54 +09:00
Suguru Hirahara
d630668f46
Update docs/configuring-playbook.md: move "Additional useful services" section down under "Bots" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:38:45 +09:00
Suguru Hirahara
2376821722
Update docs/configuring-playbook.md: create "File Storage" section under "Authentication and user-related" section
This basically follows the order of the tables on README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:37:59 +09:00
Suguru Hirahara
eaeb2f99b5
Update docs/configuring-playbook.md: move "Authentication and user-related" section up
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:37:40 +09:00
Suguru Hirahara
15fd33fb45
Update docs/configuring-playbook.md: merge "Server connectivity" section to "Core service adjustments" section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:37:13 +09:00
Suguru Hirahara
c404995456
Update docs/configuring-playbook.md: create a list for server components based on the table on README.md
Also: update README.md and docs/container-images.md

Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md)

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:34:41 +09:00
Suguru Hirahara
7511b3d3ea
Update docs/configuring-playbook.md: create a section "Clients"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:32:59 +09:00
Suguru Hirahara
6e92a5da3f
Update docs/configuring-playbook.md: move "Core service adjustments" section up
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 19:32:03 +09:00
Suguru Hirahara
55d9aa04c2
Update docs/configuring-playbook.md: remove "optional" from links
Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 17:07:43 +09:00
Suguru Hirahara
5ef203777f
Fix capitalization: draupnir → Draupnir
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 16:53:01 +09:00
Suguru Hirahara
1886a8fc4d
Update docs/updating-users-passwords.md: fix SQL command
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 12:54:15 +09:00
Suguru Hirahara
f8c9507ae1
Update docs/updating-users-passwords.md: triple backticks for syntax highlighting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 12:53:35 +09:00
Suguru Hirahara
c6f0b290bc
Update docs/configuring-playbook-bridge-appservice-webhooks.md
Use a common expression for adjusting configuration. As the component has been deprecated, this is purely for future use as a template.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 01:59:26 +09:00
Suguru Hirahara
fd1d3e6bfc
Update docs/configuring-playbook-backup-borg.md (#3724)
* Update docs/configuring-playbook-backup-borg.md

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

* Reflect the feedback

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-02 17:38:06 +02:00
Suguru Hirahara
018a8c8fdf
Update docs/configuring-playbook-s3.md: replace the URL to matrix-media-repo
The URL stopped working since some time. Linking to the internal file will keep working as long as the URL is properly managed.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-02 18:16:29 +09:00
Suguru Hirahara
6b5c66675a
Update docs/configuring-playbook-backup-borg.md and docs/configuring-playbook-ntfy.md: fix URLs
Remove "/-/" from the URLs, which is a fragment of URLs on GitLab

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-02 17:56:56 +09:00
Suguru Hirahara
24ab56b1bc
Update docs/container-images.md: create a table for deprecated or unmaintained services
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:52 +09:00
Suguru Hirahara
c2859c727c
Update docs/container-images.md: create a table for Misc
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:48 +09:00
Suguru Hirahara
a4619fec25
Update docs/container-images.md: create a table for Administration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:44 +09:00
Suguru Hirahara
292dd56eed
Update docs/container-images.md: create a table for Bots
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:39 +09:00
Suguru Hirahara
2b12ccb517
Update docs/container-images.md: create a table for Bridges
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:34 +09:00
Suguru Hirahara
d90dcc4a04
Update docs/container-images.md: create a table for File Storage
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:29 +09:00
Suguru Hirahara
ab1cce5a14
Update docs/container-images.md: create a table for Authentication
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:25 +09:00
Suguru Hirahara
f3fde12c45
Update docs/container-images.md: create tables for Clients and Server Components
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:20 +09:00
Suguru Hirahara
63e16ed034
Update docs/container-images.md: create a table for Homeserver
This is essentially an imitation of 59a01dabfc for container images. It copies the entries order and descriptions on the table of README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:33:44 +09:00
Suguru Hirahara
8f7a723b37
Update docs/configuring-playbook-bridge-mautrix-meta-instagram.md: the same paragraph as docs/configuring-playbook-bridge-mautrix-meta-messenger.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 21:59:20 +09:00
Suguru Hirahara
f5e333b513
Update docs/configuring-playbook-bridge-mautrix-meta-messenger.md: add a note about user ID of the new bridge's bot
The user ID of the new bridge (mautrix-meta) is different from that of the old bridge (mautrix-facebook). It is slightly confusing, and the note should help migration.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 21:53:28 +09:00
Suguru Hirahara
0bc4ef8f4d
Update documentation titles of deprecated or unmaintained services
Also: fix typos

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 17:31:53 +09:00
Suguru Hirahara
e9c5562ae7
Fix anchor links and its title of documents related to Amazon S3
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 16:37:41 +09:00
Suguru Hirahara
76099c8936
Update docs/configuring-playbook-s3.md about object storage providers
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 16:37:19 +09:00
Suguru Hirahara
727609c7c8
Update docs/container-images.md: create a section for container images of deprecated or unmaintained services
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 15:07:25 +09:00
Suguru Hirahara
e35dae7fca
Update docs/container-images.md: add unlisted Docker images
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 15:07:18 +09:00
Suguru Hirahara
4de16dde79
Update docs/configuring-playbook.md: add link to configuring-playbook-synapse-auto-accept-invite.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 11:24:19 +09:00
Suguru Hirahara
bf0fa1408e
Add ddclient to documentation
- Update README.md
- Update docs/configuring-playbook-dynamic-dns.md: remove reference to deceased Google Domains etc.
- Update docs/configuring-playbook.md: move documentation to server connectivity section
- Update docs/container-images.md: add linuxserver/ddclient

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 02:58:14 +09:00
Suguru Hirahara
5ebdc0c48d
Add links to matrix-user-verification-service (#3709)
* Add links to matrix-user-verification-service

Matrix User Authentication Service itself has been available for Jitsi since 42e4e50f5b.

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

* Update README.md

Co-authored-by: Slavi Pantaleev <slavi@devture.com>

* Update docs/container-images.md

* Update roles/custom/matrix-user-verification-service/defaults/main.yml

---------

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-10-31 18:26:33 +02:00
Suguru Hirahara
d200e8d084
Update README.md and docs/configuring-playbook.md: add configuring-playbook-prometheus-nginxlog.md
Since nginx has been replaced with traefik, the documentation is getting irrelevant anyway.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-31 21:07:18 +09:00
Suguru Hirahara
950147bc99
Update README.md and docs/container-images.md: add matrix-wechat
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-31 19:39:16 +09:00
Suguru Hirahara
748c38de30
Update README.md and docs/container-images.md: add mautrix-wsproxy
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-31 19:39:11 +09:00
Suguru Hirahara
f41d432ab2
Update README.md and docs/container-images.md: add mautrix-meta
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-31 19:39:03 +09:00
Suguru Hirahara
bff4321fb1
Update README.md and docs/container-images.md: add Matrix Authentication Service
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-31 19:38:50 +09:00
Suguru Hirahara
f6991b2db9
Update README.md and docs/container-images.md: add matrix-alertmanager-receiver
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-31 19:36:55 +09:00
Suguru Hirahara
0b09ad3d76
Update documentation about Slack bridges (#3706)
* Update docs/configuring-playbook-bridge-hookshot.md: matrix-appservice-webhooks has been deprecated

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

* Add notes that matrix-appservice-slack is not available for new installation

The bridge uses a classic Slack application, but its creation has been discontinued since June 4, 2024.

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

* Remove reference to matrix-hookshot and matrix-appservice-webhooks

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-10-31 11:58:04 +02:00
Suguru Hirahara
652feba9cc
Rename variables of Postmoogle to handle it as a bridge (#3698)
* Rename variables matrix_bot_postmoogle_* with matrix_postmoogle_*

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

* Rename file names and references to those files

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

* Move variables block for /matrix-bridge-postmoogle

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

* Rename matrix_playbook_bot_postmoogle_ to matrix_playbook_bridge_postmoogle_

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

* Add matrix_playbook_migration_matrix_postmoogle_migration_validation_enabled

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

* Replace an install tag example with "-bot" prefix

The previous example seems to have been selected to show how components whose name contains "-bot-" needed to be specified.

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-10-31 10:33:46 +02:00
Slavi Pantaleev
446e656424 Mark matrix_client_cinny_path_prefix as not supported anymore
Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3701

We can restore support for it by making a non-/ path prefix trigger a
self-build with a modified build config, so that a Cinny version with
path-prefix support would be produced. Traefik label changes may also be
required.

For now, we're not doing all that work, but simply dropping support for path
prefixes for Cinny.
2024-10-30 09:53:03 +02:00
Slavi Pantaleev
059cf13021 Add note about syn2mas not migrating user admin status flag
Related to https://github.com/element-hq/matrix-authentication-service/issues/3440
2024-10-29 09:59:05 +02:00
Slavi Pantaleev
2cd79e785f Mention matrix-reminder-bot incompatibility with Matrix Authentication Service 2024-10-29 09:41:21 +02:00
Suguru Hirahara
efa17d837c
Update README.md and container-images.md: replace links to the original synapse-admin with ones to its fork
The original synapse-admin (Awesome-Technologies/synapse-admin) was replaced with etke.cc/synapse-admin with 73d338d9d1 on Sep 12, 2024.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 23:58:05 +09:00
Suguru Hirahara
ecd4fc028d
Recategorize Postmoogle (#3696)
* Update configuring-playbook.md: move a link for docs/configuring-playbook-bot-postmoogle.md to Bots section

The document (on 9c2a8addee93910cb9079f856bc3fb3932592c91; initial commit to add Postmoogle) says:
> Postmoogle is a bot/bridge you can use to forward emails to Matrix rooms

Therefore it is not really incorrect to categorize Postmoogle as bridge document-wise, but since the list on README.md categorizes it as a bot, and based on the file name of the documentation, this commit moves the link for Postmoogle to the Bots section.

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

* Revert "Update configuring-playbook.md: move a link for docs/configuring-playbook-bot-postmoogle.md to Bots section"

This reverts commit 1e2e903cb9.

* Change the file name of Postmoogle documentation to make it clear that Postmoogle is a bridge

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

* Update documentation for Postmoogle related to a bridge/bot status

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-10-28 16:27:42 +02:00
Suguru Hirahara
7a791ab692
Update docs/container-images.md: replace matrixdotorg/synapse with its fork
The switch to element-hq/synapse was conducted with aa0a85b094.

Since the fork no longer belongs to Matrix Foundation, it is not quite "official" anymore, while it is enabled by default and not optional.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 19:39:07 +09:00
Suguru Hirahara
409f4195c3
Update docs/container-images.md: replace URL to matrix-appservice-slack Docker image
We have used the officially maintained image since 8f41041f6d on Sep 15, 2020.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 19:36:25 +09:00
Suguru Hirahara
ef04f5b33f
Add disclaimer to the deprecated services section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 18:18:35 +09:00
Suguru Hirahara
4bf0414555
Update docs/configuring-playbook.md: create "Deprecated / unmaintained / removed services" section
Create a dedicated section for deprecated, unmaintained, or removed services such as:

- Appservice Webhooks
- Dimension
- Go-NEB
- matrix-bot-chatgpt
- Mautrix Facebook
- Mautrix Hangouts
- Mautrix Instagram
- MX Puppet Skype

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 18:09:47 +09:00
Suguru Hirahara
ae864830e0
Update the URL to matrix-appservice-discord
The URL seems to have been changed at least since several years though the exact date is unknown to me, considering the latest tagged docker image on https://hub.docker.com/r/halfshot/matrix-appservice-discord/tags (https://hub.docker.com/layers/halfshot/matrix-appservice-discord/develop/images/sha256-a1015907545603448d2d8e2ea0d31f0fdb6c7676009e2cb38e324440a9284317) is dated Feb 15, 2021.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 17:18:03 +09:00
Suguru Hirahara
6e4ad586e4
Replace existing links to matrix-org/synapse which should be replaced
Note that links to the issues and PRs on the original repository (matrix-org/synapse) should not be replaced with ones on the forked one (element-hq/synapse) as those are not available on the latter, where the issues and PRs with the same number as matrix-org/synapse are "reserved" to avoid conflicts between those repositories. For reasoning of such complexity (including the reason why trasferring the original repository to element-hq/synapse was avoided), see: https://github.com/element-hq/synapse/issues/6#issuecomment-1861116896

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 16:43:35 +09:00
Suguru Hirahara
9cfb8c8c67
Update docs/configuring-playbook-bot-go-neb.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-10-28 16:34:20 +09:00
Suguru Hirahara
17ccd95734
Update docs/configuring-playbook-bot-chatgpt.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-10-28 16:33:35 +09:00
Suguru Hirahara
379a8677ba
Fix anchor links to matrix-hookshot
The namaspace has been replaced with 58771a9c65 on Mar 3, 2022.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 16:23:12 +09:00
Suguru Hirahara
9bd1e3e791
Update deprecation notices on documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 16:22:35 +09:00
Suguru Hirahara
0cd7404074
Update docs/configuring-playbook-bot-go-neb.md: add deprecation notice
Go-NEB has been discontinued since Jun 29, 2023. See: 3ba3d4600f

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 16:21:45 +09:00
Suguru Hirahara
afb538610d
Update documentation regarding mx-puppet-discord
The transition to the Beeper fork (https://gitlab.com/beeper/mx-puppet-monorepo) has been reverted with 3f45805fd2 on May 7, 2022 after https://github.com/matrix-discord/mx-puppet-discord was archived on Apr 17, 2022 and migrated to https://gitlab.com/mx-puppet/discord/mx-puppet-discord.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 11:53:16 +09:00
Suguru Hirahara
85ccd143ac
Update documentation regarding mx-puppet-slack
The transition to the Beeper fork (https://gitlab.com/beeper/mx-puppet-monorepo) has been reverted with 894669eca2 on May 15, 2022, after https://github.com/Sorunome/mx-puppet-slack was archived on Apr 19, 2022 and migrated to https://gitlab.com/mx-puppet/slack/mx-puppet-slack.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 11:52:45 +09:00
Suguru Hirahara
2e343b44ea
Fix capitalization: Container Images → Container images 2024-10-28 04:00:59 +09:00
Suguru Hirahara
e77b14a699
Fix capitalization: cinny → Cinny
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 04:00:45 +09:00
Suguru Hirahara
b71c4a1a3e
Consistent capitalization: honoroit → Honoroit
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 04:00:38 +09:00
Suguru Hirahara
601406ddda
Fix capitalization: buscarron → Buscarron
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 04:00:30 +09: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
Slavi Pantaleev
f9e37fc614 Adjust step number on alertmanager-receiver docs page 2024-10-26 10:32:22 +03:00
Suguru Hirahara
1c0ba91a47
Update docs/configuring-playbook-s3-goofys.md: fix the referred step number
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-25 19:07:20 +09:00
Suguru Hirahara
cbdf619bd4
Update docs/configuring-playbook-s3-goofys.md: remove repetitive suggestions to create a backup
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-25 19:07:08 +09:00
Suguru Hirahara
1b117f1757
Update docs/configuring-playbook-s3-goofys.md: update Table of Contents
It is a legacy of docs/configuring-playbook-s3.md on ac7cb3619d, and the upper levels of those two list items are redundant.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-25 19:06:33 +09:00
Suguru Hirahara
91cf8e3230
Update docs/configuring-playbook-s3-goofys.md: fix the anchor link for Backblaze B2
The link has been broken since ac7cb3619d

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-25 19:05:32 +09:00
Suguru Hirahara
082b75b0c0
Fix indentations of list items
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-25 17:15:10 +09:00
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