cryptomator / Android

Cryptomator offers multi-platform transparent client-side encryption of your files in the cloud.

Cryptomator for Android is currently available in the following distribution channels:

1. Using Google Play
2. Using Cryptomator's Website
3. Building from source using Gradle (instructions below)

Building

Dependencies

• Git
• JDK 8
• Gradle

Run Git and Gradle

git submodule init && git submodule update // (not necessary if cloned using --recurse-submodules)
./gradlew assembleApkstoreDebug

Before connecting to OneDrive or Dropbox you have to provide valid API keys using environment variables:
For build type

• release: DROPBOX_API_KEY or ONEDRIVE_API_KEY and ONEDRIVE_API_REDIRCT_URI
• debug: DROPBOX_API_KEY_DEBUG or ONEDRIVE_API_KEY_DEBUG and ONEDRIVE_API_REDIRCT_URI_DEBUG

Contributing to Cryptomator for Android

Please read our contribution guide, if you would like to report a bug, ask a question, translate the app or help us with coding.

Please make sure before creating a PR, to apply the code style by executing reformat code with optimize imports and rearrange code enabled. The best way to do this is to create a macro for it in android studio and set it to the save shortcut.

Code of Conduct

Help us keep Cryptomator open and inclusive. Please read and follow our Code of Conduct.

Deployment

Follow these steps to deploy a release:

1. Check TODO/FIXME comments
   • Create issue for or delete
   • Regexp for "Find in Path": \W(TODO|FIXME)(?! #[0-9]{1,4}:)
2. Merge translations
3. Check latest dependencies
4. Create release branch
5. Test database migration
6. Smoke-Test changed or added functionality
7. Update version
8. Create and commit release notes
9. Merge in main
10. Create tag and execute deploy app using Fastlane
11. Close GitHub-issues or move them to next milestone
12. Close milestone
13. Update version on website (cryptomator.org/android)

Release Notes

Before tagging the release, create and commit the release notes. For Playstore create fastlane/metadata/android/de-DE/changelogs/default.txt, fastlane/metadata/android/en-US/changelogs/default.txt and for the website create fastlane/release-notes.html.

Deploy app using Fastlane

Deploy production version to Google Play, Website/GitHub-Releases and F-Droid using fastlane android deploy or bundle exec fastlane deploy

There are further targets and options like beta, see fastlane/README.md

Initial setup Fastlane

1. Make sure you copied .default.env to .env in the fastlane folder and filled out those variables.
2. Install Ruby (depends on OS, Ubuntu): sudo apt install ruby-dev
3. Install fastlane (depends on OS, Ubuntu): gem install fastlane -N

License

This project is dual-licensed under the GPLv3 for FOSS projects as well as a commercial license for independent software vendors and resellers. If you want to modify this application under different conditions, feel free to contact our support team.