This commit is contained in:
Suguru Hirahara 2024-12-22 11:45:22 +01:00 committed by GitHub
commit beffb19f2c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
909 changed files with 4601 additions and 0 deletions

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
use_default_rules: true

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2019 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
# This file is the top-most EditorConfig file
root = true

4
.envrc
View File

@ -1 +1,5 @@
# SPDX-FileCopyrightText: 2023 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
use flake

4
.gitattributes vendored
View File

@ -1 +1,5 @@
# SPDX-FileCopyrightText: 2023 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
* text=auto eol=lf

4
.github/FUNDING.yml vendored
View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2020 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
# These are supported funding model platforms

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 Suguru Hirahara <acioustick@noreply.codeberg.org>
SPDX-License-Identifier: AGPL-3.0-or-later
-->
---
name: Bug report
about: Create a report to help us improve

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2024 Suguru Hirahara <acioustick@noreply.codeberg.org>
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
blank_issues_enabled: false
contact_links:

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 Suguru Hirahara <acioustick@noreply.codeberg.org>
SPDX-License-Identifier: AGPL-3.0-or-later
-->
---
name: Feature request
about: Suggest an idea for this project

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 Suguru Hirahara <acioustick@noreply.codeberg.org>
SPDX-License-Identifier: AGPL-3.0-or-later
-->
---
name: I need help
about: Get support from our community

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
version: 2
updates:

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2024 Suguru Hirahara <acioustick@noreply.codeberg.org>
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
name: 'Close stale issues and PRs'
on: # yamllint disable-line rule:truthy

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
name: Matrix CI

20
.github/workflows/reuse.yml vendored Normal file
View File

@ -0,0 +1,20 @@
# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. <https://fsfe.org>
#
# SPDX-License-Identifier: CC0-1.0
---
name: REUSE Compliance Check
on: # yamllint disable-line rule:truthy
push:
pull_request:
jobs:
reuse-compliance-check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: REUSE Compliance Check
uses: fsfe/reuse-action@v5

4
.gitignore vendored
View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2017 MDAD Team and contributors
#
# SPDX-License-Identifier: CC0-1.0
/inventory
/roles/**/files/scratchpad
.DS_Store

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
extends: default

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# 2024-11-26
## (Backward Compatibility Break) Synapse now defaults to enabling authenticated media

121
LICENSES/CC0-1.0.txt Normal file
View File

@ -0,0 +1,121 @@
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
.PHONY: roles lint
help: ## Show this help.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2017 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
[![Support room on Matrix](https://img.shields.io/matrix/matrix-docker-ansible-deploy:devture.com.svg?label=%23matrix-docker-ansible-deploy%3Adevture.com&logo=matrix&style=for-the-badge&server_fqdn=matrix.devture.com)](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) [![donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/s.pantaleev/donate)
# Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker

39
REUSE.toml Normal file
View File

@ -0,0 +1,39 @@
# SPDX-FileCopyrightText: 2024 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
version = 1
[[annotations]]
path = "docs/assets/*"
SPDX-FileCopyrightText = "2024 MDAD Team and contributors"
SPDX-License-Identifier = "AGPL-3.0-or-later"
[[annotations]]
path = "roles/custom/matrix-prometheus-nginxlog-exporter/examples/*.png"
SPDX-FileCopyrightText = "2024 MDAD Team and contributors"
SPDX-License-Identifier = "AGPL-3.0-or-later"
[[annotations]]
path = "roles/custom/**/*.json"
SPDX-FileCopyrightText = "2024 MDAD Team and contributors"
SPDX-License-Identifier = "AGPL-3.0-or-later"
# Computer-generated files
[[annotations]]
path = [
".github/renovate.json",
"roles/custom/**/*.repo",
"flake.lock",
"flake.nix",
"requirements.yml",
]
SPDX-FileCopyrightText = "NONE"
SPDX-License-Identifier = "CC0-1.0"
# https://reuse.software/faq/#aggregate-info
[[annotations]]
path = ["i18n/**/*.po"]
precedence = "aggregate"
SPDX-FileCopyrightText = "2024 MDAD Team and contributors"
SPDX-License-Identifier = "AGPL-3.0-or-later"

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2023 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# 2023
2023 was a year filled with many changes for matrix-docker-ansible-deploy. In this post, we're looking backward at some of the major changes that happened this year, as well as taking a glimpse of what's ahead in 2024.

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2017 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
[defaults]
retry_files_enabled = False
stdout_callback = yaml

View File

@ -1,4 +1,9 @@
#!/usr/bin/env bash
# SPDX-FileCopyrightText: 2024 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
#
# Run the playbook on multiple hosts with different credentials with this script
# It defaults to ansible tags "setup-all,start". You can pass alternative tags

View File

@ -1,4 +1,9 @@
#!/bin/bash
# SPDX-FileCopyrightText: 2024 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
set -euxo pipefail
# This script rebuilds the mautrix-meta-instagram Ansible role, using the mautrix-meta-messenger role as a source.

View File

@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2021 MDAD Team and contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
collections:
- name: community.general

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Table of Contents
## ⬇️ Installaton guides <!-- NOTE: the 🚀 emoji is used by "Getting started" on README.md -->

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Alternative architectures
As stated in the [Prerequisites](prerequisites.md), currently only `amd64` (`x86_64`) is fully supported.

View File

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2019 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Running this playbook

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
(Adapted from the [upstream project](https://github.com/element-hq/synapse/blob/develop/docs/CAPTCHA_SETUP.md))
# Overview

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Configuring your DNS settings
<sup>[Prerequisites](prerequisites.md) > Configuring your DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup>

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver (optional)
The playbook can install and configure the [matrix-alertmanager-receiver](https://github.com/metio/matrix-alertmanager-receiver) service for you. It's a [client](https://prometheus.io/docs/alerting/latest/clients/) for Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/), allowing you to deliver alerts to Matrix rooms.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Appservice Double Puppet (optional)
Appservice Double Puppet is a homeserver appservice through which bridges (and potentially other services) can impersonate any user on the homeserver.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Draupnir for All/D4A (optional)
The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool for you in appservice mode.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up BorgBackup (optional)
The playbook can install and configure [BorgBackup](https://www.borgbackup.org/) (short: Borg) with [borgmatic](https://torsion.org/borgmatic/) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2019 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Serving the base domain (optional)
By default, this playbook sets up services on your Matrix server (`matrix.example.com`), but has it configured so that it presents itself as the base domain (`example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up baibot (optional)
<p align="center">

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Buscarron (optional)
The playbook can install and configure [Buscarron](https://github.com/etkecc/buscarron) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2023 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up matrix-bot-chatgpt (optional, unmaintained)
**Note**: [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) is now an archived (**unmaintained**) project. Talking to ChatGPT (and many other LLM providers) can happen via the much more featureful [baibot](https://github.com/etkecc/baibot), which can be installed using [this playbook](configuring-playbook-bot-baibot.md). Consider using that bot instead of this one.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2023 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Draupnir (optional)
The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation bot for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Go-NEB (optional, unmaintained)
**Note**: [Go-NEB](https://github.com/matrix-org/go-neb) is now an archived (**unmaintained**) project. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bot instead of this one.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Honoroit (optional)
The playbook can install and configure [Honoroit](https://github.com/etkecc/honoroit) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up matrix-registration-bot (optional)
The playbook can install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up matrix-reminder-bot (optional)
The playbook can install and configure [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up maubot (optional)
The playbook can install and configure [maubot](https://github.com/maubot/maubot) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mjolnir (optional)
The playbook can install and configure the [Mjolnir](https://github.com/matrix-org/mjolnir) moderation bot for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2019 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Appservice Discord bridging (optional)
**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2019 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Appservice IRC bridging (optional)
**Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) bridge supported by the playbook.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Appservice Kakaotalk bridging (optional)
The playbook can install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) for you. `matrix-appservice-kakaotalk` is a bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2019 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Appservice Slack bridging (optional)
**Notes**:

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Appservice Webhooks bridging (optional, deprecated)
**Note**: This bridge has been deprecated. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bridge instead of this one.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Beeper Linkedin bridging (optional)
The playbook can install and configure [beeper-linkedin](https://github.com/beeper/linkedin) for you, for bridging to [LinkedIn](https://www.linkedin.com/) Messaging. This bridge is based on the mautrix-python framework and can be configured in a similar way to the other mautrix bridges

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Go Skype Bridge bridging (optional)
The playbook can install and configure [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Heisenbridge bouncer-style IRC bridging (optional)
**Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [matrix-appservice-irc](configuring-playbook-bridge-appservice-irc.md) bridge supported by the playbook.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up matrix-hookshot (optional)
The playbook can install and configure [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Matrix SMS bridging (optional)
The playbook can install and configure [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Discord bridging (optional)
**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) bridges supported by the playbook.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2019 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Facebook bridging (optional, deprecated)
**Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be installed using [this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md). Consider using that bridge instead of this one.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2023 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Google Messages bridging (optional)
The playbook can install and configure [mautrix-gmessages](https://github.com/mautrix/gmessages) for you, for bridging to [Google Messages](https://messages.google.com/).

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Google Chat bridging (optional)
The playbook can install and configure [mautrix-googlechat](https://github.com/mautrix/googlechat) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2019 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Hangouts bridging (optional, deprecated)
💡 **Note**: This bridge has been deprecated in favor of [Google Chat bridge](https://github.com/mautrix/googlechat), which can be installed using [this playbook](configuring-playbook-bridge-mautrix-googlechat.md). Installing the mautrix-hangouts bridge is **no longer possible**. For now, this documentation page remains here for historical purposes.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Instagram bridging (optional, deprecated)
**Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be installed using [this playbook](configuring-playbook-bridge-mautrix-meta-instagram.md). Consider using that bridge instead of this one.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Instagram bridging via Mautrix Meta (optional)
The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Messenger bridging via Mautrix Meta (optional)
The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Signal bridging (optional)
The playbook can install and configure [mautrix-signal](https://github.com/mautrix/signal) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2023 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Slack bridging (optional)
**Note**: bridging to [Slack](https://slack.com/) can also happen via the [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) and [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) bridges supported by the playbook.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Telegram bridging (optional)
The playbook can install and configure [mautrix-telegram](https://github.com/mautrix/telegram) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Twitter bridging (optional)
**Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) bridge supported by the playbook.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix Whatsapp bridging (optional)
The playbook can install and configure [mautrix-whatsapp](https://github.com/mautrix/whatsapp) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2023 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage (optional)
The playbook can install and configure [mautrix-wsproxy](https://github.com/mautrix/wsproxy) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up MX Puppet Discord bridging (optional)
**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md)and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up MX Puppet GroupMe bridging (optional)
The playbook can install and configure [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up MX Puppet Instagram bridging (optional)
The playbook can install and configure [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up MX Puppet Skype bridging (optional, removed)
The playbook used to be able to install and configure [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype), but no longer includes this component, because it has been broken and unmaintained for a long time.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up MX Puppet Slack bridging (optional)
**Note**: bridging to [Slack](https://slack.com) can also happen via the [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) and [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridges supported by the playbook. Note that `matrix-appservice-slack` is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up MX Puppet Steam bridging (optional)
The playbook can install and configure [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up MX Puppet Twitter bridging (optional)
**Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mautrix-twitter](configuring-playbook-bridge-mautrix-twitter.md) bridge supported by the playbook.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Postmoogle email bridging (optional)
**Note**: email bridging can also happen via the [email2matrix](configuring-playbook-email2matrix.md) bridge supported by the playbook.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up WeChat bridging (optional)
The playbook can install and configure the [matrix-wechat](https://github.com/duo/matrix-wechat) bridge for you (for bridging to the [WeChat](https://www.wechat.com/) network).

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Cactus Comments (optional)
The playbook can install and configure the [Cactus Comments](https://cactus.chat) system for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Cinny (optional)
This playbook can install the [Cinny](https://github.com/ajbura/cinny) Matrix web client for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Configuring Element Web (optional)
By default, this playbook installs the [Element Web](https://github.com/element-hq/element-web) Matrix client for you. If that's okay, you can skip this document.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Hydrogen (optional)
This playbook can install the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up SchildiChat Web (optional)
This playbook can install the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) Matrix client for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Configuring Conduit (optional)
By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Conduit](https://conduit.rs).

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Configuring Dendrite (optional)
By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Dendrite](https://github.com/matrix-org/dendrite).

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2019 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Dimension integration manager (optional, unmaintained)
**[Dimension](https://dimension.t2bot.io) can only be installed after Matrix services are installed and running.** If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) flow and come back here later.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Dynamic DNS (optional)
The playbook can configure Dynamic DNS with [ddclient](https://github.com/ddclient/ddclient) for you. It is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Adjusting email-sending settings (optional)
By default, this playbook sets up an [Exim](https://www.exim.org/) email server through which all Matrix services send emails.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2019 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Email2Matrix (optional)
**Note**: email bridging can also happen via the [Postmoogle](configuring-playbook-bridge-postmoogle.md) bridge supported by the playbook. Postmoogle is much more powerful and easier to use, so we recommend that you use it, instead of Email2Matrix.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2021 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Etherpad (optional)
[Etherpad](https://etherpad.org) is an open source collaborative text editor that can be embedded in a Matrix chat room using the [Dimension integration manager](https://dimension.t2bot.io) or used as standalone web app.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Using an external PostgreSQL server (optional)
By default, this playbook would set up a PostgreSQL database server on your machine, running in a Docker container. If that's okay, you can skip this document.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Controlling Matrix federation (optional)
By default, your server federates with the whole Matrix network. That is, people on your server can communicate with people on any other Matrix server.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up the Jitsi video-conferencing platform (optional)
The playbook can install the [Jitsi](https://jitsi.org/) video-conferencing platform and integrate it with Element clients ([Element Web](configuring-playbook-client-element-web.md)/Desktop, Android and iOS).

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up the LDAP authentication password provider module (optional, advanced)
The playbook can install and configure the [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) LDAP Auth password provider for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up ma1sd Identity Server (optional)
**⚠Note**: ma1sd itself has also been unmaintained for years (the latest commit and release being from 2021). The role of identity servers in the Matrix specification also has an uncertain future. **We recommend not bothering with installing it unless it's the only way you can do what you need to do**. For example, certain things like LDAP integration can also be implemented via [the LDAP provider module for Synapse](./configuring-playbook-ldap-auth.md).

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Matrix Authentication Service (optional)
This playbook can install and configure [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service/) (MAS) - a service operating alongside your existing [Synapse](./configuring-playbook-synapse.md) homeserver and providing [better authentication, session management and permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/).

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2018 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up Matrix Corporal (optional, advanced)
<hr/>

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up matrix-ldap-registration-proxy (optional)
The playbook can install and configure [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) for you.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2023 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Storing Matrix media files using matrix-media-repo (optional)
[matrix-media-repo](https://docs.t2bot.io/matrix-media-repo/) (often abbreviated "MMR") is a highly customizable multi-domain media repository for Matrix. Intended for medium to large environments consisting of several homeservers, this media repo de-duplicates media (including remote media) while being fully compliant with the specification.

View File

@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2020 MDAD Team and contributors
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Setting up matrix-registration (optional)
The playbook can install and configure [matrix-registration](https://github.com/ZerataX/matrix-registration) for you.

Some files were not shown because too many files have changed in this diff Show More