Files
quik/README.md
T
karol 1a140650af
Build and Release APK / Build APK (push) Successful in 4m5s
Retry failed Matrix backfill messages and persist import progress
2026-10-18 00:44:23 +02:00

189 lines
11 KiB
Markdown

# Quik Fork with Remotrix Matrix Bridge
> [!NOTE]
> This project is a hard fork of the open-source **Quik** SMS messenger application. It has been modified to natively integrate **Remotrix**, a background service that bridges your SMS messages to a Matrix homeserver.
## Why this fork?
The original Remotrix project was a standalone background bridge that required a separate, default SMS handler application. By deeply integrating Remotrix directly into Quik, we created a single, unified SMS application that offers a beautiful Material Design UI on the phone, while silently syncing all messages to your Matrix account (via Trixnity) in the background.
**Key enhancements in this fork:**
* **Native Matrix Background Sync**: SMS messages sent or received on the phone are instantly bridged to your Matrix account.
* **Two-way Communication**: Messages sent from Matrix are instantly forwarded as standard SMS messages from the phone.
* **Coroutines Deadlock Fix**: Upgraded Room database dependencies to resolve fatal `SQLiteConnectionPool` deadlocks during the cryptographic key generation phases.
* **Enhanced Visual Formatting**: Matrix messages now use intuitive prefixes (🟢 for outgoing, 🔴 for incoming) to clearly distinguish participants without requiring AppService double puppeting.
* **Gitea Actions CI/CD**: Includes automated builds and automatic upstream fetching from the original Quik repository.
## Management Room
When you log into the application with your Matrix bot account (`@remotrix:yourserver.com`) and specify a Manager ID (`@you:yourserver.com`), the bot creates a dedicated **Management Room** and invites you.
From there, you can issue commands:
- `!new <phone_number>` - Opens a new Matrix room dedicated to chatting with that phone number.
- `!close` - Deletes a chat room.
- `!ping` - Checks bot latency.
- `!reload` - Restarts the background service.
Any non-command text sent in a dedicated phone number room will be sent as an SMS to that contact.
## Starting over with Matrix
In Quik settings, open the Matrix login dialog and select **Reset Matrix**.
Confirm the reset, remove the old rooms on your Matrix server, then sign in again.
The reset removes local Matrix accounts, room mappings, encryption stores and bridge logs;
SMS messages, Quik settings, the Manager ID and the backfill limit are preserved.
New rooms use contact names from Android, and SMS history is copied again up to the configured limit.
## History import
History import retries a failed message before advancing, with retry delays up to one minute.
Synapse room-creation limits still apply. There is no fixed delay after each successful message.
Progress is stored by native message type and ID, so identical SMS texts remain separate messages
and saved progress is skipped when an unfinished import resumes. Reset Matrix clears this progress.
The completion flag means all selected messages were handed to the persistent Matrix outbox
(or intentionally excluded by forwarding settings); outbox delivery remains managed by Trixnity.
Logcat reports progress and retry positions without logging SMS bodies or phone numbers.
Upgrading preserves an existing completed-import flag. It does not automatically replay old history:
older versions did not retain per-message progress, so replaying that history could create duplicates.
Checkpoint storage and the Matrix outbox use separate databases; an abrupt process/device failure
between enqueueing a message and saving its checkpoint can still replay that last message.
## Persistent release signing
Release APKs require the permanent signing key. Missing signing configuration fails the build;
release builds never fall back to a generated debug key. Pull requests build and test Debug
without release secrets and do not publish releases.
Gitea repository **Settings → Actions → Secrets** must contain:
- `ANDROID_KEYSTORE_BASE64`: base64-encoded permanent PKCS12 keystore.
- `ANDROID_KEYSTORE_PASSWORD`: keystore password.
- `ANDROID_KEY_ALIAS`: signing key alias.
- `ANDROID_KEY_PASSWORD`: private key password.
The public certificate and its SHA-256 fingerprint are tracked in `.gitea/release-signing.crt`
and `.gitea/release-signing.sha256`. CI checks the restored key and the finished Release APK
against this fingerprint before publishing. The temporary CI key is removed even after failure.
Do not regenerate the signing key between builds; back up the key and passwords securely.
The initial local backup is `.secrets/quik-release.p12` with credentials in
`.secrets/release-signing.json`. These private files are ignored by Git and must not be committed.
For a local Release build, set `ANDROID_KEYSTORE_PATH`, `ANDROID_KEYSTORE_PASSWORD`,
`ANDROID_KEY_ALIAS` and `ANDROID_KEY_PASSWORD`. Existing local `.gradle/.gradlerc` properties
and the legacy CI environment names are also supported. Debug APKs use a separate application ID
and are intended for development.
The former builds 50 and 51 used different disposable debug certificates. The new permanent key
cannot update either installation in place; migrating once to the new certificate requires a
reinstall. Subsequent Release updates keep the same signature.
## Building and Releasing (Fork CI/CD)
The project uses Gitea Actions for CI/CD:
- `build.yml`: Automatically builds the Debug and Release APKs (`assembleDebug`, `assembleRelease`) upon pushing to `master` or creating a tag. If a tag (e.g., `v1.0.0`) is pushed, a Gitea Release is created automatically.
- `sync.yml`: Runs weekly to automatically fetch changes from the original `quik` upstream repository and merge them into our fork.
To build manually:
```bash
./gradlew assembleDebug
```
The APK will be available in `presentation/build/outputs/apk/debug/`.
---
# Original Quik Documentation Below:
![octoshrimpy/QUIK](.github/octoshrimpy_quik.jpg)
# QUIK
[![Manual Release](https://github.com/octoshrimpy/quik/actions/workflows/manual-release.yml/badge.svg)](https://github.com/octoshrimpy/quik/actions/workflows/manual-release.yml)
<a href="https://hosted.weblate.org/engage/quik/"><img src="https://hosted.weblate.org/widget/quik/svg-badge.svg" alt="Translation status" /></a>
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/octoshrimpy/quik)
QUIK is an open source replacement to the [stock messaging app](https://github.com/android/platform_packages_apps_mms) on Android. It is a continuation of [QKSMS](https://github.com/moezbhatti/qksms).
## Features
- Scheduled messages
- Message backup
- Speech-to-text and text-to-speech integrated within the app
- Message blocking and archiving
- Voice messages
- Attachments of any type of file
- Message sorting
- Message pinning
- Delayed sending
- Quick reply from notifications
- Swipe actions
- Emoji reaction handling
- and much, much more
## Download
Grab QUIK from the official [github releases page](https://github.com/octoshrimpy/quik/releases), or keep up with updates with the following:
<a href="https://f-droid.org/repository/browse/?fdid=dev.octoshrimpy.quik.fdroid"><img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="100"></a>
<a href="https://apps.obtainium.imranr.dev/redirect?r=obtainium://app/{%22id%22:%22dev.octoshrimpy.quik%22,%22url%22:%22https://github.com/octoshrimpy/quik%22,%22author%22:%22octoshrimpy%22,%22name%22:%22QUIK%22,%22additionalSettings%22:%22{\%22apkFilterRegEx\%22:\%22release\%22,\%22invertAPKFilter\%22:false,\%22about\%22:\%22QUIK%20is%20an%20open%20source%20replacement%20for%20the%20stock%20messaging%20app%20on%20Android.%20It%20is%20a%20continuation%20of%20QKSMS.\%22}%22}"><img src="https://raw.githubusercontent.com/ImranR98/Obtainium/b1c8ac6f2ab08497189721a788a5763e28ff64cd/assets/graphics/badge_obtainium.png" alt="Get it on Obtainium" height="100"></a>
<a href="https://github.com/octoshrimpy/quik/releases">
<img src="https://user-images.githubusercontent.com/69304392/148696068-0cfea65d-b18f-4685-82b5-329a330b1c0d.png"
alt="Download from GitHub releases" height="100" /></a>
<!--
</a><a href="https://play.google.com/store/apps/details?id=dev.octoshrimpy.quik"><img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" alt="Download on Google Play" height="100">
-->
## Matrix Chat
You can chat with the community over at [#quik-sms:matrix.org](https://matrix.to/#/#quik-sms:matrix.org)
## Reporting bugs
A great bug report contains a description of the problem and steps to reproduce the problem. We need to know what we're looking for and where to look for it.
When reporting a bug, please make sure to provide the following information:
- Steps to reproduce the issue
- QUIK version
- Device / OS information
## Contributing
Contributions are very welcome! Please see the [contributing guidelines](/CONTRIBUTING.md) for details.
## Translations
If you'd like to add translations to QUIK, please join the project on [Weblate](https://hosted.weblate.org/engage/quik/)! Translations that are committed directly to source files will not be accepted. For more information see the [translation guidelines](/CONTRIBUTING.md#translate).
<a href="https://hosted.weblate.org/engage/quik/">
<img src="https://hosted.weblate.org/widget/quik/multi-auto.svg" alt="Translation status" />
</a>
## Thank you
A special thank you to Jake ([@klinker41](https://github.com/klinker41)) and Luke Klinker ([@klinker24](https://github.com/klinker24)) for their work on [android-smsmms](https://github.com/klinker41/android-smsmms), which has been an unspeakably large help in implementing MMS into QUIK.
A giant thank you to Moez [moezbhatti](https://github.com/moezbhatti) for creating and maintaining QKSMS, of which QUIK would not exist without.
## Contact
QUIK is developed and maintained by [Marcos Jones](https://github.com/octoshrimpy).
---
## Star History
<a href="https://star-history.dera.page/#quik-sms/quik&type=Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://star-history.dera.page/svg?repos=quik-sms/quik&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://star-history.dera.page/svg?repos=quik-sms/quik&type=Date" />
<img alt="Star History Chart" src="https://star-history.dera.page/svg?repos=quik-sms/quik&type=Date" />
</picture>
</a>
---
<!-- <a href="https://liberapay.com/octoshrimpy/donate"><img alt="Donate using Liberapay" src="https://img.shields.io/badge/Liberapay-F6C915?style=for-the-badge&logo=liberapay&logoColor=black"></a> -->
<a style="background-color: #5e40c2;" href="https://ko-fi.com/octoshrimpy/donate"><img alt="Donate using Ko-Fi" src="https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white"></a>
<a href="https://patreon.com/octoshrimpy"><img alt="Donate using Patreon" src="https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white"></a>
## License
QUIK is released under the **The GNU General Public License v3.0 (GPLv3)**, which can be found in the [LICENSE](LICENSE) file in the root of this project.