Commit Graph

1481 Commits

Author SHA1 Message Date
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