From c5646712b62052a4fb5793b611b81cbe93bc8c3a Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 14 Oct 2024 23:34:07 +0900 Subject: [PATCH 1/2] Update docs/configuring-playbook-email2matrix.md: fix the anchor link text and add a section for installing Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-email2matrix.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index 7fbd49a76..cf170eb81 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -36,7 +36,7 @@ What matters is that both you and the sender user are part of the same room and Inviting additional people to the room is okay too. Take note of each room's room ID (different clients show the room ID in a different place). -You'll need the room ID when doing [Configuration](#configuration) below. +You'll need the room ID when [configuring the playbook](#adjusting-the-playbook-configuration) below. ### Obtaining an access token for the sender user @@ -72,4 +72,8 @@ matrix_email2matrix_matrix_mappings: You can also set `MatrixHomeserverUrl` to the container URL where your homeserver's Client-Server API lives by using the `{{ matrix_addons_homeserver_client_api_url }}` variable, instead of the public `https://matrix.DOMAIN` endpoint. -Re-run the playbook (`--tags=setup-email2matrix,start`) and try sending an email to `my-mailbox@matrix.DOMAIN`. +## Installing + +To enable Email2Matrix, run the [installation](installing.md) command (`--tags=setup-email2matrix,start`). + +After installation, you may wish to send a test email to `my-mailbox@matrix.DOMAIN` to make sure that Email2Matrix works as expected. From 08dfa094ea2cc81ce0d9daf1eecc5eaf2d6a7058 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 14 Oct 2024 23:35:51 +0900 Subject: [PATCH 2/2] Update docs/configuring-playbook-email2matrix.md: adjust line breaks Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-email2matrix.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index cf170eb81..5612edd23 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -1,7 +1,6 @@ # Setting up Email2Matrix (optional) -**Note**: email bridging can also happen via the [Postmoogle](configuring-playbook-bot-postmoogle.md) bot supported by the playbook. -Postmoogle is much more powerful and easier to use, so we recommend that you use it, instead of Email2Matrix. +**Note**: email bridging can also happen via the [Postmoogle](configuring-playbook-bot-postmoogle.md) bot 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. @@ -17,27 +16,26 @@ It's not strictly necessary, but you may increase the chances that incoming emai ### Port availability Ensure that port 25 is available on your Matrix server and open in your firewall. + If you have `postfix` or some other email server software installed, you may need to manually remove it first (unless you need it, of course). If you really need to run an email server on the Matrix machine for other purposes, it may be possible to run Email2Matrix on another port (with a configuration like `matrix_email2matrix_smtp_host_bind_port: "127.0.0.01:2525"`) and have your other email server relay messages there. + For details about using Email2Matrix alongside [Postfix](http://www.postfix.org/), see [here](https://github.com/devture/email2matrix/blob/master/docs/setup_with_postfix.md). ### Creating a user -Before enabling Email2Matrix, you'd most likely wish to create a dedicated user (or more) that would be sending messages on the Matrix side. -Refer to [Registering users](registering-users.md) for ways to do that. A regular (non-admin) user works best. +Before enabling Email2Matrix, you'd most likely wish to create a dedicated user (or more) that would be sending messages on the Matrix side. Refer to [Registering users](registering-users.md) for ways to do that. A regular (non-admin) user works best. ### Creating a shared room -After creating a sender user, you should create one or more Matrix rooms that you share with that user. -It doesn't matter who creates and owns the rooms and who joins later (you or the sender user). +After creating a sender user, you should create one or more Matrix rooms that you share with that user. It doesn't matter who creates and owns the rooms and who joins later (you or the sender user). What matters is that both you and the sender user are part of the same room and that the sender user has enough privileges in the room to be able to send messages there. + Inviting additional people to the room is okay too. -Take note of each room's room ID (different clients show the room ID in a different place). -You'll need the room ID when [configuring the playbook](#adjusting-the-playbook-configuration) below. - +Take note of each room's room ID (different clients show the room ID in a different place). You'll need the room ID when [configuring the playbook](#adjusting-the-playbook-configuration) below. ### Obtaining an access token for the sender user