From fa33e0b4bd079a5b2abd34404cede9442ba15a8d Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 27 Dec 2024 10:52:13 -0500 Subject: [PATCH 1/4] Update docs/configuring-playbook-email2matrix.md: add the common section "Extending the configuration" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-email2matrix.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index 7b24cd335..91b0c22a3 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -100,6 +100,14 @@ where: Refer to the official documentation [here](https://github.com/devture/email2matrix/blob/master/docs/configuration.md). +### Extending the configuration + +There are some additional things you may wish to configure about the component. + +Take a look at: + +- `roles/custom/matrix-email2matrix/defaults/main.yml` for some variables that you can customize via your `vars.yml` file + ## Installing After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: From e1f2d764e5a89d17ef748a9d69530286d277e8d0 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 26 Jan 2025 03:48:55 +0900 Subject: [PATCH 2/4] Update docs/configuring-playbook-email2matrix.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-email2matrix.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index 91b0c22a3..cf181214b 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -124,3 +124,15 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start `just install-service email2matrix` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note `just setup-all` runs the `ensure-matrix-users-created` tag too. - After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected. + +## Troubleshooting + +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-email2matrix`. + +### Increase logging verbosity + +If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: + +```yaml +matrix_email2matrix_misc_debug: true +``` From 3c33f0be3b34e04bfdd34d5e7a397c11b36b6f69 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 26 Jan 2025 20:43:57 +0900 Subject: [PATCH 3/4] Update files for Email2Matrix: fix capitalization Signed-off-by: Suguru Hirahara --- CHANGELOG.md | 2 +- YEAR-IN-REVIEW.md | 2 +- docs/configuring-playbook-bridge-postmoogle.md | 2 +- docs/configuring-playbook-email2matrix.md | 2 +- roles/custom/matrix-email2matrix/tasks/validate_config.yml | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b8994ef1..37f10f2ef 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1673,7 +1673,7 @@ See our [Setting up Cactus Comments](docs/configuring-playbook-cactus-comments.m ## Postmoogle email bridge support -Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up the new [Postmoogle](https://github.com/etkecc/postmoogle) email bridge. Postmoogle is like the [email2matrix bridge](https://github.com/devture/email2matrix) (also [already supported by the playbook](docs/configuring-playbook-email2matrix.md)), but more capable and with the intention to soon support *sending* emails, not just receiving. +Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up the new [Postmoogle](https://github.com/etkecc/postmoogle) email bridge. Postmoogle is like the [Email2Matrix bridge](https://github.com/devture/email2matrix) (also [already supported by the playbook](docs/configuring-playbook-email2matrix.md)), but more capable and with the intention to soon support *sending* emails, not just receiving. See our [Setting up Postmoogle email bridging](docs/configuring-playbook-bridge-postmoogle.md) documentation to get started. diff --git a/YEAR-IN-REVIEW.md b/YEAR-IN-REVIEW.md index d14602f08..bac3d10ac 100644 --- a/YEAR-IN-REVIEW.md +++ b/YEAR-IN-REVIEW.md @@ -69,7 +69,7 @@ When it comes to the `matrix-docker-ansible-deploy` Ansible playbook, 2022 was t Support for the following new **bridges** was added: -* [Postmoogle](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#postmoogle-email-bridge-support) for bi-directional email bridging, which supersedes my old and simplistic [email2matrix](https://github.com/devture/email2matrix) one-way bridge-bot +* [Postmoogle](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#postmoogle-email-bridge-support) for bi-directional email bridging, which supersedes my old and simplistic [Email2Matrix](https://github.com/devture/email2matrix) one-way bridge-bot * [mautrix-discord](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#mautrix-discord-support) * [go-skype-bridge](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#go-skype-bridge-bridging-support) * [matrix-appservice-kakaotalk](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix-appservice-kakaotalk-support) diff --git a/docs/configuring-playbook-bridge-postmoogle.md b/docs/configuring-playbook-bridge-postmoogle.md index 20ecce4c7..8613b40a7 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -1,6 +1,6 @@ # Setting up Postmoogle email bridging (optional) -**Note**: email bridging can also happen via the [email2matrix](configuring-playbook-email2matrix.md) bridge supported by the playbook. +**Note**: email bridging can also happen via the [Email2Matrix](configuring-playbook-email2matrix.md) bridge supported by the playbook. The playbook can install and configure [Postmoogle](https://github.com/etkecc/postmoogle) for you. diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index cf181214b..ec9094b91 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -2,7 +2,7 @@ **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. -The playbook can install and configure [email2matrix](https://github.com/devture/email2matrix) for you. +The playbook can install and configure [Email2Matrix](https://github.com/devture/email2matrix) for you. See the project's [documentation](https://github.com/devture/email2matrix/blob/master/docs/README.md) to learn what it does and why it might be useful to you. diff --git a/roles/custom/matrix-email2matrix/tasks/validate_config.yml b/roles/custom/matrix-email2matrix/tasks/validate_config.yml index 27cd9eaa0..eab9b3268 100644 --- a/roles/custom/matrix-email2matrix/tasks/validate_config.yml +++ b/roles/custom/matrix-email2matrix/tasks/validate_config.yml @@ -1,12 +1,12 @@ --- -- name: Fail if no email2matrix mappings +- name: Fail if no Email2Matrix mappings ansible.builtin.fail: msg: > You need to define at least one mapping in `matrix_email2matrix_matrix_mappings` for enabling Email2Matrix. when: "matrix_email2matrix_matrix_mappings | length == 0" -- name: Fail if required email2matrix settings not defined +- name: Fail if required Email2Matrix settings not defined ansible.builtin.fail: msg: >- You need to define a required configuration setting (`{{ item.name }}`). From 8f2c51305a7889212e2f726a71858e368de984da Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 26 Jan 2025 20:52:27 +0900 Subject: [PATCH 4/4] Update files for Email2Matrix: reflect the fact that the component has been deprecated Unfortunately Email2Matrix has been deprecated this month. See: https://github.com/devture/email2matrix/commit/f1032f0ac8619c3a7b52ec3eca05645237ecc5a6. As a long time user of the component, I'd like to shout out a big thank-you to Slavi! Signed-off-by: Suguru Hirahara --- README.md | 1 - docs/configuring-playbook-bridge-postmoogle.md | 2 -- docs/configuring-playbook-email2matrix.md | 4 ++-- docs/configuring-playbook.md | 4 ++-- docs/container-images.md | 2 +- 5 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d3e2a4dbc..b9f27539c 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,6 @@ Bridges can be used to connect your Matrix installation with third-party communi | [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) | ❌ | Bridge to [Discord](https://discordapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-discord.md) | | [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-groupme.md) | | [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-steam.md) | -| [Email2Matrix](https://github.com/devture/email2matrix) | ❌ | Bridge for relaying emails to Matrix rooms | [Link](docs/configuring-playbook-email2matrix.md) | | [Postmoogle](https://github.com/etkecc/postmoogle) | ❌ | Email to Matrix bridge | [Link](docs/configuring-playbook-bridge-postmoogle.md) | ### Bots diff --git a/docs/configuring-playbook-bridge-postmoogle.md b/docs/configuring-playbook-bridge-postmoogle.md index 8613b40a7..18321207e 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -1,7 +1,5 @@ # Setting up Postmoogle email bridging (optional) -**Note**: email bridging can also happen via the [Email2Matrix](configuring-playbook-email2matrix.md) bridge supported by the playbook. - The playbook can install and configure [Postmoogle](https://github.com/etkecc/postmoogle) for you. Postmoogle is a bridge you can use to have its bot user forward emails to Matrix rooms. It runs an SMTP email server and allows you to assign mailbox addresses to the rooms. diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index ec9094b91..ec91658bb 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -1,6 +1,6 @@ -# Setting up Email2Matrix (optional) +# Setting up Email2Matrix (optional, deprecated) -**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. +**Note**: this component has been deprecated. We recommend not bothering with installing it. While not a 1:1 replacement, the author suggests taking a look at [Postmoogle](https://github.com/etkecc/postmoogle) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-postmoogle.md). Consider using that component instead of this one. The playbook can install and configure [Email2Matrix](https://github.com/devture/email2matrix) for you. diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index a2332f9bf..ea371c99b 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -161,8 +161,6 @@ Bridges can be used to connect your Matrix installation with third-party communi - [Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md) -- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) - - [Setting up Postmoogle email bridging](configuring-playbook-bridge-postmoogle.md) - [Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md) @@ -244,6 +242,8 @@ Various services that don't fit any other categories. - [Setting up the Dimension integration manager](configuring-playbook-dimension.md) ([unmaintained](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2806#issuecomment-1673559299); after [installing](installing.md)) +- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (unmaintained; the author suggests taking a look at [Postmoogle](https://github.com/etkecc/postmoogle) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-postmoogle.md)) + - [Setting up Go-NEB](configuring-playbook-bot-go-neb.md) (unmaintained; 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)) - [Setting up matrix-bot-chatgpt](configuring-playbook-bot-chatgpt.md) (unmaintained; the bridge's author suggests taking a look at [baibot](https://github.com/etkecc/baibot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bot-baibot.md)) diff --git a/docs/container-images.md b/docs/container-images.md index 4c43786b8..99ae94330 100644 --- a/docs/container-images.md +++ b/docs/container-images.md @@ -94,7 +94,6 @@ Bridges can be used to connect your Matrix installation with third-party communi | [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) | [mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry) | ❌ | Bridge to [Discord](https://discordapp.com/) | | [mx-puppet-groupme](configuring-playbook-bridge-mx-puppet-groupme.md) | [xangelix/mx-puppet-groupme](https://hub.docker.com/r/xangelix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) | | [mx-puppet-steam](configuring-playbook-bridge-mx-puppet-steam.md) | [icewind1991/mx-puppet-steam](https://hub.docker.com/r/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) | -| [Email2Matrix](configuring-playbook-email2matrix.md) | [devture/email2matrix](https://hub.docker.com/r/devture/email2matrix/) | ❌ | Bridge for relaying emails to Matrix rooms | | [Postmoogle](configuring-playbook-bridge-postmoogle.md) | [etke.cc/postmoogle](https://github.com/etkecc/postmoogle/container_registry) | ❌ | Email to Matrix bridge | ## Bots @@ -158,6 +157,7 @@ The list of the deprecated or unmaintained services is available [here](configur | ------- | --------------- | -------- | ----------- | | [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md) | [turt2live/matrix-appservice-webhooks](https://hub.docker.com/r/turt2live/matrix-appservice-webhooks) | ❌ | Bridge for slack compatible webhooks ([ConcourseCI](https://concourse-ci.org/), [Slack](https://slack.com/) etc. pp.) | | [Dimension](configuring-playbook-dimension.md) | [turt2live/matrix-dimension](https://hub.docker.com/r/turt2live/matrix-dimension) | ❌ | An open source integration manager for Matrix clients | +| [Email2Matrix](configuring-playbook-email2matrix.md) | [devture/email2matrix](https://hub.docker.com/r/devture/email2matrix/) | ❌ | Bridge for relaying emails to Matrix rooms | | [Go-NEB](configuring-playbook-bot-go-neb.md) | [matrixdotorg/go-neb](https://hub.docker.com/r/matrixdotorg/go-neb) | ❌ | A multi functional bot written in Go | | [matrix-chatgpt-bot](configuring-playbook-bot-chatgpt.md) | [matrixgpt/matrix-chatgpt-bot](https://ghcr.io/matrixgpt/matrix-chatgpt-bot) | ❌ | Accessing ChatGPT via your favourite Matrix client | | [mautrix-facebook](configuring-playbook-bridge-mautrix-facebook.md) | [mautrix/facebook](https://mau.dev/mautrix/facebook/container_registry) | ❌ | Bridge to [Facebook](https://facebook.com/) |