-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Edit docs for signal-bridge, coturn, postmoogle #2174
Changes from all commits
1503640
4bd005f
d84e1bb
cc8805f
c9c6f71
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,9 +35,59 @@ matrix_bot_postmoogle_enabled: true | |
matrix_bot_postmoogle_password: PASSWORD_FOR_THE_BOT | ||
``` | ||
|
||
You will also need to add several DNS records so that postmoogle can send emails. | ||
## Use Postmoogle for sending mails | ||
|
||
You will need to add several DNS records | ||
See [Configuring DNS](configuring-dns.md). | ||
|
||
To be able to get the value for `!pm dkim` for your DNS settings you need to have admin-rights for the bridge. | ||
If you didn't set this generally for all bridges with: | ||
```yaml | ||
matrix_admin: "@username:{{ matrix_domain }}" | ||
``` | ||
you need to set one for administering postmoogle with this item in your `vars.yml`: | ||
```yaml | ||
matrix_bot_postmoogle_admins: | ||
- "@<username>:{{ matrix_domain }}" | ||
``` | ||
|
||
If you want to use TLS (you should) and you use `matrix_ssl_retrieval_method: manually-managed`) you have to add to `vars.yml`: | ||
```yaml | ||
### SSL | ||
## on-host SSL dir | ||
matrix_bot_postmoogle_ssl_path: "" | ||
|
||
## in-container SSL paths | ||
# matrix_bot_postmoogle_tls_cert is the SSL certificate's certificate. | ||
# This is likely set via group_vars/matrix_servers, so you don't need to set it. | ||
# If you do need to set it manually, note that this is an in-container path. | ||
# To mount a certificates volumes into the container, use matrix_bot_postmoogle_ssl_path | ||
# Example value: /ssl/live/{{ matrix_bot_postmoogle_domain }}/fullchain.pem | ||
matrix_bot_postmoogle_tls_cert: "" | ||
|
||
# matrix_bot_postmoogle_tls_key is the SSL certificate's key. | ||
# This is likely set via group_vars/matrix_servers, so you don't need to set it. | ||
# If you do need to set it manually, note that this is an in-container path. | ||
# To mount a certificates volumes into the container, use matrix_bot_postmoogle_ssl_path | ||
# Example value: /ssl/live/{{ matrix_bot_postmoogle_domain }}/privkey.pem | ||
matrix_bot_postmoogle_tls_key: "" | ||
``` | ||
**Note:** `matrix_bot_postmoogle_ssl_path:` defaults to what you set for `matrix_ssl_config_dir_path:` As seen in [/group_vars/matrix_servers](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/group_vars/matrix_servers#L1213) but it has to be set again to make postmoogle look for it outside the docker-container. | ||
|
||
## Open Ports | ||
If you run a firewall on your server and/or it sits behind a NAT-Router, remember to open/forward the ports `25` (for non-TLS) and `587` (TLS) | ||
as set [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/roles/matrix-bot-postmoogle/defaults/main.yml#L121) | ||
|
||
It's possible to change those ports in `vars.yml` with: | ||
```yaml | ||
matrix_bot_postmoogle_smtp_host_bind_port: "" | ||
matrix_bot_postmoogle_submission_host_bind_port: "" | ||
``` | ||
Comment on lines
+81
to
+85
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't see how this is helpful. Why do most users need to change the standard ports that email operates on? |
||
|
||
If you want to enforce TLS on both ports add this to `vars.yml`: | ||
```yaml | ||
matrix_bot_postmoogle_tls_required: true | ||
``` | ||
Comment on lines
+87
to
+90
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This also seems unrelated to the "Open ports" section, which deals with telling people what ports to open in their firewall for Postmoogle to work. There are many other variables that we may wish to mention on this documentation page, but.. it's better to point the user to the Important options could be mentioned, but I'm not sure this is an important one. Seeing it, it also makes me think "How do I know if I want to enforce TLS? Is it better to do it?" .. and I suspect the answer to this one is:
|
||
|
||
## Installing | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -79,7 +79,35 @@ When using this method, **each user** that wishes to enable Double Puppeting nee | |
|
||
- make sure you don't log out the `Mautrix-Signal` device some time in the future, as that would break the Double Puppeting feature | ||
|
||
## Enable End-to-End-Encryption | ||
|
||
To enable the Bridge to work in encrypted rooms add this to your `vars.yml` file: | ||
``` yaml | ||
matrix_mautrix_signal_configuration_extension_yaml: | | ||
bridge: | ||
encryption: | ||
allow: true | ||
default: true | ||
``` | ||
As seen in the mentioned [upstream-documentation](https://docs.mau.fi/bridges/python/signal/index.html): | ||
- `allow: true` the bridge won't enable encryption on its own, but will work in encrypted rooms | ||
- `default: true` the bridge will automatically enable encryption in new portals. | ||
|
||
**Note**: | ||
* [Upstream-documentation](https://docs.mau.fi/bridges/python/signal/index.html) mentions to make sure using postgres if enabling the bridge in encrypted rooms. | ||
* Careful when setting `matrix_mautrix_signal_configuration_extension_yaml:`: If you already used this item before for setting permissions add the part: | ||
``` | ||
encryption: | ||
allow: true | ||
default: true | ||
``` | ||
below the permission-part. | ||
Comment on lines
+96
to
+104
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Indentantion is broken in the YAML block (mixing tabs and spaces). You also seem to be basing this PR on some older commit.. We don't have an Enable End-to-End-Encryption section in We do have a a new docs page that applies to all mautrix bridges: It'd be better if we link to |
||
|
||
## Usage | ||
|
||
You then need to start a chat with `@signalbot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain). | ||
|
||
If you want to invite Signal-contacts to an existing Matrix-Room. | ||
- invite `@signalbot:<matrix-domain>` into the room (refer to [Enable End-to-End-Encryption](#Enable End-to-End-Encryption)) | ||
- type `!signal create`, which will create the Signal-Group | ||
- invite the contacts you want |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link to
master
is a moving target. Line 121 will change sooner or later.You'd better link to a specific commit, or not link there are all. It's better to mention the file (
roles/matrix-bot-postmoogle/defaults/main.yml
) and variables and their default values, but... in this case, it's useless.Changing these ports is something that most people don't need to do. It's a good way to make your server not work well with the rest of the world.