You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Edit docs/configuring-playbook-email2matrix.md: adopt the common instruction
Based on docs/configuring-playbook-dimension.md and docs/configuring-playbook-bot-go-neb.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Copy file name to clipboardExpand all lines: docs/configuring-playbook-email2matrix.md
+21-12Lines changed: 21 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,25 @@ If you really need to run an email server on the Matrix machine for other purpos
22
22
23
23
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).
24
24
25
-
### Creating a user
25
+
### Register a dedicated Matrix user (optional)
26
26
27
-
Before enabling Email2Matrix, you'd most likely wish to create a dedicated user (or more) that would be sending messages on the Matrix side. Take note of the user's ID as it needs to be specified as `MatrixUserId` on your `inventory/host_vars/matrix.example.com/vars.yml` file later.
27
+
We recommend that youcreate a dedicated Matrix user for Email2Matrix.
28
28
29
-
Refer to [Registering users](registering-users.md) for ways to create a user. A regular (non-admin) user works best.
29
+
Generate a strong password for the user. You can create one with a command like `pwgen -s 64 1`.
30
+
31
+
You can use the playbook to [register a new user](registering-users.md):
Take note of the user's ID as it needs to be specified as `MatrixUserId` on your `inventory/host_vars/matrix.example.com/vars.yml` file later.
38
+
39
+
### Obtain an access token
40
+
41
+
Email2Matrix requires an access token for the sender user to be able to send messages to the room. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).
42
+
43
+
⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.
30
44
31
45
### Creating a shared room
32
46
@@ -38,25 +52,20 @@ Inviting additional people to the room is okay too.
38
52
39
53
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.
40
54
41
-
### Obtain an access token for the sender user
42
-
43
-
In order for the sender user created above to be able to send messages to the room, we'll need to obtain an access token for it. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).
44
-
45
-
⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.
46
-
47
55
## Adjusting the playbook configuration
48
56
49
-
After doing the preparation steps above, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):
57
+
To enable Email2Matrix, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_FOR_EMAIL2MATRIX1_HERE` and `ACCESS_TOKEN_FOR_EMAIL2MATRIX2_HERE` with the ones created [above](#obtain-an-access-token).
0 commit comments