mirror of
https://github.com/mautrix/imessage.git
synced 2026-11-16 23:04:43 +00:00
2
Bridge setup
Tulir Asokan edited this page 2021-02-09 17:16:31 +02:00
Requirements
Compilation (optional)
- Go 1.13+ (download & installation instructions at https://golang.org/dl/)
- libolm3 with dev headers (
brew install libolm)
Runtime
- A computer running a reasonably new version of macOS
- A Matrix homeserver that supports application services (e.g. Synapse)
- A websocket proxy to receive appservice transactions
Installation
You may either compile the bridge manually or download a prebuilt executable from the mau.dev CI.
Compiling manually
- Clone the repo with
git clone https://github.com/tulir/mautrix-imessage.git. - Enter the directory (
cd mautrix-imessage). - Run
./build.shto fetch Go dependencies and compile (build.shwill simply callgo buildwith some additional flags).
Downloading a prebuilt executable
- Go to https://mau.dev/tulir/mautrix-imessage/pipelines?scope=branches&page=1
- Find the entry for the
masterbranch and click the download button on the right-hand side in the list.- There are three entries: universal, arm64 (Apple Silicon) and amd64 (Intel). You can either pick universal or the specific architecture depending on what Mac you have.
- Extract the downloaded zip file into a new directory.
Configuring and running
- Copy
example-config.yamltoconfig.yaml - Update the config to your liking.
- You need to make sure that the
addressanddomainfield point to your homeserver. - You will also need to add your user ID to the
bridgesection.
- You need to make sure that the
- Generate the appservice registration file by running
./mautrix-imessage -g.- You can use the
-cand-rflags to change the location of the config and registration files. They default toconfig.yamlandregistration.yamlrespectively.
- You can use the
- Set up mautrix-wsproxy and update the generated registration file to point to it. Also update the
websocket_proxyfield in the bridge config if you didn't do that already. - Add the path to the registration file (
registration.yamlby default) to your synapsehomeserver.yamlunderapp_service_config_files. You will then need to restart the synapse server. Remember to restart it every time the registration file is regenerated. - Run the bridge with
./mautrix-imessage.