matrix-docker-ansible-deploy/docs/configuring-playbook-bot-postmoogle.md
2022-08-22 20:10:35 +03:00

1.9 KiB

Setting up Postmoogle (optional)

Note: email bridging can also happen via the email2matrix bridge supported by the playbook.

The playbook can install and configure Postmoogle for you.

It's a bot/bridge you can use to forward emails to Matrix rooms

See the project's documentation to learn what it does and why it might be useful to you.

Registering the bot user

By default, the playbook will set up the bot with a username like this: @postmoogle:DOMAIN.

(to use a different username, adjust the matrix_bot_postmoogle_login variable).

You need to register the bot user manually before setting up the bot. You can use the playbook to register a new user:

ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=postmoogle password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user

Choose a strong password for the bot. You can generate a good password with a command like this: pwgen -s 64 1.

Adjusting the playbook configuration

Add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file:

matrix_bot_postmoogle_enabled: true

# Adjust this to whatever password you chose when registering the bot user
matrix_bot_postmoogle_password: PASSWORD_FOR_THE_BOT

Installing

After configuring the playbook, run the installation command again:

ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start

Usage

To use the bot, invite the @postmoogle:DOMAIN into a room you want to use as a mailbox, after that send mailbox NAME to enable email address NAME@matrix.domain and start receiving emails

Send help to the room to see the bot's help menu for additional commands.

You can also refer to the upstream documentation.