Add a secondary option on how to get access token

Potentially the CURLing could be a better approach, since then you don't leave spare sessions hanging.
This commit is contained in:
vaivars 2020-07-29 19:53:39 +03:00 committed by GitHub
parent 050442af11
commit fad1f72df8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -37,7 +37,8 @@ We recommend that you create a dedicated Matrix user for Dimension (`dimension`
Follow our [Registering users](registering-users.md) guide to learn how to register **a regular (non-admin) user**. Follow our [Registering users](registering-users.md) guide to learn how to register **a regular (non-admin) user**.
You are required to specify an access token (belonging to this new user) for Dimension to work. You are required to specify an access token (belonging to this new user) for Dimension to work.
To get an access token for the Dimension user, follow these steps: To get an access token for the Dimension user, you can follow one of two options:
*Through an interactive login*:
1. In a private browsing session (incognito window), open Element. 1. In a private browsing session (incognito window), open Element.
2. Log in with the `dimension` user and its password. 2. Log in with the `dimension` user and its password.
@ -46,6 +47,17 @@ To get an access token for the Dimension user, follow these steps:
3. Copy the highlighted text to your configuration. 3. Copy the highlighted text to your configuration.
4. Close the private browsing session. **Do not log out**. Logging out will invalidate the token, making it not work. 4. Close the private browsing session. **Do not log out**. Logging out will invalidate the token, making it not work.
*With CURL*
```
curl -X POST --header 'Content-Type: application/json' -d '{
"identifier": { "type": "m.id.user", "user": "YourDimensionUsername" },
"password": "YourDimensionPassword",
"type": "m.login.password"
}' 'http://localhost:8008/_matrix/client/r0/login'
```
*Change the "YourDimensionUser/Pass" accordingly*
**Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.** **Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.**
Add access token to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): Add access token to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):