build.md

From source

• Binaries
  • Requirements
  • Build
• Debian package
• Docker image
• Next steps

Binaries

Requirements

• JDK 1.8
• OpenJDK 11
• OpenJDK 14

Build

git clone https://github.com/ma1uta/ma1sd.git
cd ma1sd
./gradlew build

Create a new configuration file by coping ma1sd.example.yaml to ma1sd.yaml and edit to your needs.
For advanced configuration, see the Configure section.

Start the server in foreground to validate the build and configuration:

java -jar build/libs/ma1sd.jar

Ensure the signing key is available:

$ curl 'http://localhost:8090/_matrix/identity/api/v1/pubkey/ed25519:0'

{"public_key":"..."}

Test basic recursive lookup (requires Internet connection with access to TCP 443):

$ curl 'http://localhost:8090/_matrix/identity/api/v1/lookup?medium=email&[email protected]'

{"address":"[email protected]","medium":"email","mxid":"@ma1sd-lookup-test:kamax.io",...}

If you enabled LDAP, you can also validate your config with a similar request after replacing the address value with something present within your LDAP

curl 'http://localhost:8090/_matrix/identity/api/v1/lookup?medium=email&[email protected]'

If you plan on testing the integration with a homeserver, you will need to run an HTTPS reverse proxy in front of it as the reference Home Server implementation synapse requires a HTTPS connection to an ID server.

Next step: Install your compiled binaries

Debian package

Requirements:

• fakeroot
• dpkg-deb

Build ma1sd then:

./gradlew debBuild

You will find the debian package in build/dist.
Then follow the instruction in the Debian package document.

Docker image

Build ma1sd then:

./gradlew dockerBuild

Then follow the instructions in the Docker install document.

Multi-platform builds

Provided with experimental docker feature buildx To build the arm64 and amd64 images run:

./gradlew dockerBuildX

Next steps

• Integrate with your infrastructure