matrix-docker-ansible-deploy/docs/configuring-playbook-bot-postmoogle.md

89 lines
3.5 KiB
Markdown
Raw Normal View History

2022-08-22 17:10:35 +00:00
# Setting up Postmoogle (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.
2022-08-22 17:10:35 +00:00
2024-09-06 22:05:34 +00:00
It's a bot/bridge you can use to forward emails to Matrix rooms.
2023-05-30 06:09:24 +00:00
Postmoogle runs an SMTP email server and allows you to assign mailbox addresses to Matrix rooms.
2022-08-22 17:10:35 +00:00
See the project's [documentation](https://github.com/etkecc/postmoogle) to learn what it does and why it might be useful to you.
2022-08-22 17:10:35 +00:00
## Prerequisites
2022-08-22 17:10:35 +00:00
2023-05-30 06:09:24 +00:00
### Networking
Open the following ports on your server to be able to receive incoming emails:
- `25/tcp`: SMTP
2023-05-30 06:09:24 +00:00
- `587/tcp`: Submission (TLS-encrypted SMTP)
2023-05-30 06:09:24 +00:00
If you don't open these ports, you will still be able to send emails, but not receive any.
2023-05-30 06:09:24 +00:00
These port numbers are configurable via the `matrix_bot_postmoogle_smtp_host_bind_port` and `matrix_bot_postmoogle_submission_host_bind_port` variables, but other email servers will try to deliver on these default (standard) ports, so changing them is of little use.
### Adjusting the playbook configuration
2022-08-22 17:10:35 +00:00
Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
```yaml
matrix_bot_postmoogle_enabled: true
# Uncomment and adjust this part if you'd like to use a username different than the default
# matrix_bot_postmoogle_login: postmoogle
# Generate a strong password here. Consider generating it with `pwgen -s 64 1`
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_password: PASSWORD_FOR_THE_BOT
2023-05-30 06:09:24 +00:00
# Uncomment to add one or more admins to this bridge:
#
# matrix_bot_postmoogle_admins:
# - '@yourAdminAccount:domain.com'
#
# .. unless you've made yourself an admin of all bridges like this:
#
# matrix_admin: '@yourAdminAccount:domain.com'
```
### DNS
2023-05-30 06:09:24 +00:00
You will also need to add several DNS records so that Postmoogle can send emails.
2022-09-09 07:47:00 +00:00
See [Configuring DNS](configuring-dns.md).
2022-08-22 17:10:35 +00:00
## Installing
After configuring the playbook, run the [installation](installing.md) command again:
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
2022-08-22 17:10:35 +00:00
```
**Notes**:
- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account
- 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
2022-08-22 17:10:35 +00:00
## Usage
2024-09-06 22:05:34 +00:00
To use the bot, invite the `@postmoogle:DOMAIN` 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.domain`. Emails sent to that email address will be forwarded to the room.
2022-08-22 17:10:35 +00:00
2022-08-22 17:23:39 +00:00
Send `!pm help` to the room to see the bot's help menu for additional commands.
2022-08-22 17:10:35 +00:00
You can also refer to the upstream [documentation](https://github.com/etkecc/postmoogle).
### Debug/Logs
2023-05-30 06:09:24 +00:00
As with all other services, you can find their logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by running something like `journalctl -fu matrix-bot-postmoogle`
2024-09-06 22:05:34 +00:00
The default logging level for this bridge is `INFO`, but you can increase it to `DEBUG` with the following additional configuration:
```yaml
matrix_bot_postmoogle_loglevel: 'DEBUG'
```