Commit Graph

213 Commits

Author SHA1 Message Date
Slavi Pantaleev
1a87f92647 Emojify main README
✓ and x indicators provide less visibility, as they're very similarly
looking.

Emojis (especially when colored) make it much easier to see which
component is a default one and which isn't.

Section headings are also prefixed with an emoji now to make
decrease the "wall of text" feeling.
2024-11-06 09:24:46 +02:00
Slavi Pantaleev
db57c95cc0 Remove redundant Installation section from main README
Superseded by the new "Getting started" section, which is higher up and
gets more visibility.
2024-11-06 09:17:55 +02:00
Slavi Pantaleev
c8c83252be Add "Getting started" section to main README
We were linking to the "guided installation" even now, but there are so
many links and no explicit "Getting started" link anywhere.
This tries to make things better.

Inspired by:

- https://news.ycombinator.com/item?id=42039447
- https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3744
2024-11-05 10:39:05 +02:00
1over137
065d3ac066
Documentation: sliding sync proxy is not required for Synapse >1.114 (#3735)
* Update configuring-playbook-sliding-sync-proxy.md

* Update README.md

* Apply suggestions from code review

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

---------

Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-05 09:37:11 +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
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
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
2bf31da947
Update README.md: remove deprecated or unmaintained services from the supported services section
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 15:47:36 +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
8db65bb811
Update README.md: add link to configuring-playbook-appservice-draupnir-for-all.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-31 21:09:02 +09: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
0a8dd90b5e
Update README.md: add matrix-appservice-kakaotalk
matrix-appservice-kakaotalk itself was added to the playbook with e46ba5deba. It also does not provide its container image.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-31 21:06:59 +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
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
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
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
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
b71c4a1a3e
Consistent capitalization: honoroit → Honoroit
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 04:00:38 +09: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
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
55fcaac1f1
Fix capitalization: matrix → Matrix
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 23:35:10 +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
Slavi Pantaleev
1851973734 Add support for baibot
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3369
2024-09-12 15:19:46 +03:00
Slavi Pantaleev
283dd6494f Switch all etke.cc links (from Gitlab to Github)
Related to https://etke.cc/news/d3uw4utq4t3_rpxicrrfqqou_ynmptqjgk95pt-3n2s/
2024-09-07 02:43:00 +03:00
Aine
1c0b14f63c
Update SaaS section in readme (#3455)
* Update SaaS section in readme

* Improve sentence wording

* Improve sentence flow

---------

Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-07-30 16:02:48 +03:00
Michael Hollister
55f869254b
Created role for synapse-usage-exporter (#3442)
* Created role for synapse-usage-exporter

* Apply suggestions from code review

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

* Renaming docker variables and moving synapse stats config location

* Respect devture_systemd_docker_base_docker_service_name

---------

Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-07-25 20:19:08 +03:00
Slavi Pantaleev
0049ddf002 Add Pantalaimon support
This is actually authored by Julian Foad here
(https://lab.trax.im/matrix/matrix-docker-ansible-deploy), but was in
need of a rebase and various adjustments caused by huge playbook
refactoring that landed in the past months.

This rework is completely untested.

Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/266
2024-03-24 18:35:34 +02:00
xvsun
905bdfc551
Add Synapse module auto accept invite to rooms and direct messages (#3195)
* feat: auto-accept-invite module and docs

* fix: name typos and some forgot to adjust variables

* fix: accept only direct messages should work now and better wording

* changed: only_direct_messages variable naming

* feat: add logger, add synapse workers config

* Fix typo and add details about synapse-auto-acccept-invite

* Add newline at end of file

* Fix alignment

* Fix logger name for synapse_auto_accept_invite

The name of the logger needs to match the name of the Python module.

Ref: d673c67678/synapse_auto_accept_invite/__init__.py (L20)

* Add missing document start YAML annotation

* Remove trailing spaces

---------

Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-02-21 18:04:14 +02:00
Slavi Pantaleev
c0afcaa2e3 Replace (almost) all matrix-org/synapse references with element-hq/synapse
Issues and Pull Requests were not migrated to the new
organization/repository, so `matrix-org/synapse/pull` and
`matrix-org/synapse/issues` references were kept as-is.

`matrix-org/synapse-s3-storage-provider` references were also kept,
as that module still continues living under the `matrix-org` organization.

This patch mainly aims to change documentation-related things, not actual
usage in full yet. For polish that, another more comprehensive patch is coming later.
2024-01-17 08:02:47 +02:00
Slavi Pantaleev
f4f3d57520 Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
Pierre 'McFly' Marty
6bd581ef7f
refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
Slavi Pantaleev
9cc4c8f169
Reword the Related secton of the README 2023-12-14 11:35:01 +02:00
Joe Kappus
cc70203008
Update README.md: add mash-playbook, remove archived playbooks 2023-12-14 03:28:33 -05:00
Aine
afec1f9815
add packages support to the aux role 2023-11-24 14:30:43 +02:00
mcnesium
642924514f
fix link to configuring-playbook-matrix-media-repo.md 2023-09-23 11:18:53 +02:00
Catalan Lover
2f6829e6d7
Replace links to Gnuxie/Draupnir with the-draupnir-project/Draupnir
Draupnir moved its repo on github from the namespace of its maintainer Gnuxie to a newly created Github Organisation the-draupnir-project and this commit reflects this.
2023-09-07 19:33:25 +02:00
Array in a Matrix
7322e3bfb5
Improve bridge descriptions 2023-08-31 14:59:38 -04:00
Array in a Matrix
8b9143a1e5
Add more descriptive description 2023-08-31 14:49:06 -04:00
Aine
b70081b4e9
fix schildichat link in readme 2023-08-31 13:34:42 +03:00
Aine
86655db995
add SchildiChat client 2023-08-30 19:23:52 +03:00
Shreyas Ajjarapu
5ea6aa3e50
Added Google Messager Bridge (#2794)
* intial commit

* changed

* Reorderd

* merge old changes

* added changes to matrix_servers

* Remove duplicate discord

* Update main.yml

* added google message to configuring-playbook.md

* Changed docs to add new changes

* Changed bug?

* Removed problem j2 values

* Rename a service files

* change how password hash string

* Changed port number

* Change how the local part works

* Revert "Merge pull request #8 from shreyasajj/wsproxy"

This reverts commit bb1b8fc67c, reversing
changes made to cce6ba5f9d.

---------

Co-authored-by: Shreyas Ajjarapu <github.tzarina@aleeas.com>
2023-07-21 14:33:52 +03:00
Michael Hollister
78bd1dbd1b Added matrix-media-repo role 2023-07-12 01:09:27 -05:00