diff --git a/bridges/go/imessage/android/setup.md b/bridges/go/imessage/android/setup.md index 56056a8..8ccaa4b 100644 --- a/bridges/go/imessage/android/setup.md +++ b/bridges/go/imessage/android/setup.md @@ -8,33 +8,35 @@ bridge is [android-sms]. [android-sms]: https://gitlab.com/beeper/android-sms ## Requirements +### Compilation (optional) +* Go 1.14+ (download & installation instructions at ). +* Latest Android SDK and NDK version 21.3.6528147. + +### Runtime * An Android device with Android 5 or higher. * A Matrix homeserver that supports application services (e.g. [Synapse](https://github.com/matrix-org/synapse)). You need access to register an appservice, which usually involves editing the homeserver config file. -* A [websocket proxy](https://github.com/mautrix/wsproxy) to receive - appservice transactions. If you want end-to-bridge encryption, the [sync - proxy] component (mentioned in the websocket proxy readme) is also recommended - to minimize battery usage. +* A [websocket proxy](https://github.com/mautrix/wsproxy) to receive appservice + transactions. If you want end-to-bridge encryption, the [sync proxy] component + (mentioned in the websocket proxy readme) is also recommended to minimize + battery usage. [sync proxy]: https://github.com/mautrix/syncproxy ## Installation ### Compiling manually -1. Install the latest Android SDK and NDK version 21.3.6528147. -2. Clone the android-sms repo. Use `--recursive` when cloning or +1. Clone the android-sms repo. Use `--recursive` when cloning or `git submodule init && git submodule update` after cloning to ensure that the mautrix-imessage submodule is present. -3. Run `./mautrix.sh` to compile mautrix-imessage for Android. -4. Put your `config.yaml` in `app/src/main/assets/` (create the directory - if it doesn't exist). -5. Run `./gradlew installDebug` to compile the app and install it over ADB. +2. Run `./mautrix.sh` to compile mautrix-imessage for Android. +3. Run `./gradlew installDebug` to compile the app and install it over ADB. ### Precompiled builds -There are currently no precompiled versions available, as the config must be -bundled at compile time. Support for setting up with QR code similar to the iOS -setup will be added soon(™), and precompiled APKs will be available in the -GitLab CI after that. +Pre-compiled APKs are available in [GitLab CI]. In the future, they'll +hopefully also be available from F-Droid. + +[GitLab CI]: https://gitlab.com/beeper/android-sms/-/pipelines ## Configuring and running 1. Get the [example config] and fill it out. You'll at least need to: @@ -47,12 +49,7 @@ GitLab CI after that. 2. Get the [example registration] and copy the relevant values from the config. 3. Set up [mautrix-wsproxy](https://github.com/mautrix/wsproxy) (and the [sync proxy](https://github.com/mautrix/syncproxy)). -4. Add the path to the registration file to your Synapse `homeserver.yaml` - under `app_service_config_files`, then restart Synapse. -5. Build and run the android-sms app with your config. -6. Open the app and grant it SMS permissions to start the bridge. - - +7. Scan the QR code with the android-sms app (install the app now if you didn't already). +8. Grant at least the SMS permission when prompted. Contact list access is also + necessary if you want proper displaynames for ghost users on Matrix. [example config]: https://github.com/mautrix/imessage/blob/master/example-config.yaml [example registration]: https://github.com/mautrix/imessage/blob/master/example-registration.yaml +[Registering appservices]: ../../../general/registering-appservices.md