From bdc38f77b5d9c69e9bbfab664c81ddd95d75ca00 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 28 Oct 2024 22:12:51 +0900 Subject: [PATCH] Update documentation for Postmoogle related to a bridge/bot status Signed-off-by: Suguru Hirahara --- CHANGELOG.md | 2 +- docs/configuring-playbook-bridge-postmoogle.md | 10 +++++----- docs/configuring-playbook-email2matrix.md | 2 +- roles/custom/matrix-bot-postmoogle/defaults/main.yml | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d0beb1922..c56c2f4bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1571,7 +1571,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/bot. 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/docs/configuring-playbook-bridge-postmoogle.md b/docs/configuring-playbook-bridge-postmoogle.md index 5d12f7b2a..4a7f31c26 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -4,7 +4,7 @@ The playbook can install and configure [Postmoogle](https://github.com/etkecc/postmoogle) for you. -Postmoogle is a bot/bridge you can use to forward emails to Matrix rooms. It runs an SMTP email server and allows you to assign mailbox addresses to Matrix rooms. +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. See the project's [documentation](https://github.com/etkecc/postmoogle) to learn what it does and why it might be useful to you. @@ -57,18 +57,18 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use **Notes**: -- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account +- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create a user account of the bridge's bot -- if you change the bot password (`matrix_bot_postmoogle_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_postmoogle_password` to let the bot know its new password +- if you change the bridge's bot password (`matrix_bot_postmoogle_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_postmoogle_password` to let the bot know its new password ## Usage -To use the bot, invite the `@postmoogle:example.com` bot user into a room you want to use as a mailbox. +To use the bridge, invite the `@postmoogle:example.com` bot user into a room you want to use as a mailbox. Then send `!pm mailbox NAME` to expose this Matrix room as an inbox with the email address `NAME@matrix.example.com`. Emails sent to that email address will be forwarded to the room. -Send `!pm help` to the room to see the bot's help menu for additional commands. +Send `!pm help` to the room to see the bridge's help menu for additional commands. You can also refer to the upstream [documentation](https://github.com/etkecc/postmoogle). diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index 2a8333e09..ab274afe4 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -1,6 +1,6 @@ # Setting up Email2Matrix (optional) -**Note**: email bridging can also happen via the [Postmoogle](configuring-playbook-bridge-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-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. diff --git a/roles/custom/matrix-bot-postmoogle/defaults/main.yml b/roles/custom/matrix-bot-postmoogle/defaults/main.yml index 19d1590c5..faade072c 100644 --- a/roles/custom/matrix-bot-postmoogle/defaults/main.yml +++ b/roles/custom/matrix-bot-postmoogle/defaults/main.yml @@ -1,5 +1,5 @@ --- -# postmoogle is an email to Matrix bot +# postmoogle is an email to Matrix bridge using its bot user # Project source code URL: https://github.com/etkecc/postmoogle matrix_bot_postmoogle_enabled: true