From b343c6f86214a22ace877dc543656c1fdffe5b01 Mon Sep 17 00:00:00 2001 From: Matthias Date: Mon, 26 Mar 2018 23:27:04 +0200 Subject: [PATCH] Update readme to have howTo for ChangePasswordInterceptor --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 087e726..9d1803b 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,15 @@ This is done in several steps: 2nd step: Implement the other apis to integrade [mxisd](https://github.com/kamax-io/mxisd/blob/master/docs/backends/rest.md) +This bot takes care for user accounts. So it stores the credentials itself and provides ways to access them via matrix-synapse-rest-auth or mxisd. ## How to install - Copy `config.sample.php` to `config.php` and configure the bot as you can find there -- Configure your webserver to publish the folder `public` and configure. - The folder `internal` contains files that can be accessed by mxisd or matrix-synapse-rest-auth -- To integrate with matrix-synapse-rest-auth: +- Configure your webserver to publish the folder `public`. + The folder `internal` contains files that can be accessed by mxisd or matrix-synapse-rest-auth or else via a reverse proxy +- To integrate with [matrix-synapse-rest-auth](https://github.com/kamax-io/matrix-synapse-rest-auth): - `/_matrix-internal/identity/v1/check_credentials` should map to `internal/login.php` -- To integrate with mxisd: Have a look at [the docs](https://github.com/kamax-io/mxisd/blob/master/docs/backends/rest.md) and apply as follows: +- To integrate with [mxisd](https://github.com/kamax-io/mxisd): Have a look at [the docs](https://github.com/kamax-io/mxisd/blob/master/docs/backends/rest.md) and apply as follows: | Key | file which handles that | Description | @@ -30,3 +31,17 @@ This is done in several steps: | rest.endpoints.directory | internal/directory_search.php | Search for users by arbitrary input | | rest.endpoints.identity.single | internal/identity_single.php | Endpoint to query a single 3PID | | rest.endpoints.identity.bulk | internal/identity_bulk.php | Endpoint to query a list of 3PID | + + +## Implement usage of additional features: +### Use the ChangePasswortInterceptor: + +You need a reverse proxy which maps `/_matrix/client/r0/account/password` to `internal/intercept_change_password.php`. +Here is an example for nginx: + +``` + location /_matrix/client/r0/account/password { + proxy_pass http://localhost/mxbot/internal/intercept_change_password.php; + proxy_set_header X-Forwarded-For $remote_addr; + } +``` \ No newline at end of file