Instructions for setting up a local Synapse instance

User story: I am a Liberty developer. I want to run a stable Synapse build on a local VM, so I can test against it.

Suggested solution: Instructions to:

1. Create an LDAP resource with Shipwright (in progress, see https://source.puri.sm/liberty/ldh_developer/issues/10)

2. Create a new Shipwright VM

3. Run an Ansible playbook to install Synapse on the VM

   • Add the official apt repository

   • Install relevant packages

   • Configure for existing LDAP instance

Success:

1. I can create and start a Synapse VM as above.

2. I can authenticate against the Synapse VM with credentials stored in the LDAP resource. (Using the Riot web interface or another client would be great, but this is not required. Command-line authentication is fine.)

Notes:

• The official apt repo is listed at https://matrix.org/docs/projects/server/synapse.html but it may not contain the LDAP-ready version of Synapse. If not, you may need to talk to @jonas.smedegaard about locating debs for that version. If this requires a step 2.1. "Download debs from these URLs: ..." that's fine.

• Running from the latest (or near-latest) build of Synapse is sufficient. Running Synapse from source is out-of-scope.

• Storage, TURN, other authentication options, bridges and federation are very much out of scope. If it's possible to authenticate two accounts from two clients, and message each other, that would be nice, but not required.

• Using the built-in web client is not required, but if it's the easiest method to test authentication, that's fine.