Merge branch 'master' of https://github.com/spantaleev/matrix-docker-ansible-deploy

docs/configuring-playbook-bridge-mautrix-facebook.md

@@ -8,4 +8,59 @@ See the project's [documentation](https://github.com/tulir/mautrix-facebook/wiki
 matrix_mautrix_facebook_enabled: true
 ```
 
+## Usage
+
 You then need to start a chat with `@facebookbot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain).
+
+
+### Set up bridging
+
+Send `login YOUR_FACEBOOK_EMAIL_ADDRESS YOUR_FACEBOOK_PASSWORD` to the bridge bot to enable bridging for your Facebook/Messenger account.
+
+You can learn more here about authentication from the bridge's [official documentation on Authentication](https://github.com/tulir/mautrix-facebook/wiki/Authentication).
+
+If you run into trouble, check the [Troubleshooting](#troubleshooting) section below.
+
+After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting).
+
+
+### Set up Double Puppeting
+
+**Note**: Double Puppeting can be configured only after you've already [set up bridging](#set-up-bridging).
+
+If you'd like to use [Double Puppeting](https://github.com/tulir/mautrix-facebook/wiki/Authentication#double-puppeting) (hint: you most likely do), you should:
+
+- retrieve a Matrix access token for yourself. You can use the following command:
+
+```
+curl \
+--data '{"identifier": {"type": "m.id.user", "user": "YOUR_MATRIX_USERNAME" }, "password": "YOUR_MATRIX_PASSWORD", "type": "m.login.password", "device_id": "Mautrix-Facebook", "initial_device_display_name": "Mautrix-Facebook"}' \
+https://matrix.DOMAIN/_matrix/client/r0/login
+```
+
+- send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE`
+
+- make sure you don't log out the `Mautrix-Facebook` device some time in the future, as that would break the Double Puppeting feature
+
+
+## Troubleshooting
+
+### Facebook rejecting login attempts and forcing you to change password
+
+If your Matrix server is in a wildly different location than where you usually use your Facebook account from, the bridge's login attempts may be outright rejected by Facebook. Along with that, Facebook may even force you to change the account's password.
+
+If you happen to run into this problem while [setting up bridging](#set-up-bridging), try to first get a successful session up by logging in to Facebook through the Matrix server's IP address.
+
+The easiest way to do this may be to use [sshuttle](https://sshuttle.readthedocs.io/) to proxy your traffic through the Matrix server.
+
+Example command for proxying your traffic through the Matrix server:
+
+```
+sshuttle -r root@matrix.DOMAIN:22 0/0
+```
+
+Once connected, you should be able to verify that you're browsing the web through the Matrix server's IP by checking [icanhazip](https://icanhazip.com/).
+
+Then proceed to log in to [Facebook/Messenger](https://www.facebook.com/).
+
+Once logged in, proceed to [set up bridging](#set-up-bridging).

docs/installing.md

@@ -39,3 +39,4 @@ Now that the services are running, you might want to:
 - or [set up the Dimension Integrations Manager](configuring-playbook-dimension.md)
 - or [check if services work](maintenance-checking-services.md)
 - or learn how to [upgrade your services when new versions are released](maintenance-upgrading-services.md)
+- or learn how to [migrate to another server](maintenance-migrating.md)

docs/maintenance-migrating.md

@@ -0,0 +1,8 @@
+# Migrating to new server
+
+1. Prepare by lowering DNS TTL for your domains (`matrix.DOMAIN`, etc.), so that DNS record changes (step 4 below) would happen faster, leading ot less downtime
+2. Stop all services on the old server and make sure they won't be starting again. Execute this on the old server: `systemctl disable --now matrix*` 
+3. Copy directory `/matrix` from the old server to the new server. Make sure to preserve ownership and permissions (use `cp -p` or `rsync -ar`)!
+4. Make sure your DNS records are adjusted to point to the new server's IP address
+5. Remove old server from the `inventory/hosts` file and add new server.
+6. Run `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`. This will create the matrix user and group and start all services on the new server