2016-10-31 16:42:03 +01:00
2017-07-21 15:56:48 +02:00
[](http://twitter.com/Cryptomator)
[](https://community.cryptomator.org)
2019-11-13 13:29:31 +01:00
[](https://docs.cryptomator.org)
2020-12-23 15:53:46 +01:00
[](https://crowdin.com/project/cryptomator-android)
2017-07-21 15:56:48 +02:00
2020-12-21 15:52:03 +01:00
Cryptomator offers multi-platform transparent client-side encryption of your files in the cloud.
2016-10-31 16:42:03 +01:00
2020-12-21 15:52:03 +01:00
Cryptomator for Android is currently available in the following distribution channels:
2016-10-31 16:42:03 +01:00
2020-12-21 15:52:03 +01:00
1. [Using Google Play ](https://play.google.com/store/apps/details?id=org.cryptomator )
2. [Using Cryptomator's Website ](https://cryptomator.org/android/ )
2021-04-18 22:38:52 +02:00
3. [Using Cryptomator's F-Droid Repository ](https://cryptomator.org/android/ )
4. Building from source using Gradle (instructions below)
2017-01-30 21:20:27 +01:00
2020-12-21 15:52:03 +01:00
## Building
2016-10-31 16:42:03 +01:00
2020-12-21 15:52:03 +01:00
### Dependencies
* Git
* JDK 8
* Gradle
### Run Git and Gradle
```
git submodule init & & git submodule update // (not necessary if cloned using --recurse-submodules)
2021-01-12 15:23:31 +01:00
./gradlew assembleApkstoreDebug
2020-12-21 15:52:03 +01:00
```
2021-01-21 12:10:44 +01:00
Before connecting to OneDrive or Dropbox you have to provide valid API keys using environment variables:
2021-01-20 18:44:17 +01:00
For build type
2021-01-21 12:10:44 +01:00
* **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`
2020-12-21 15:52:03 +01:00
2021-01-21 12:04:35 +01:00
## Contributing to Cryptomator for Android
Please read our [contribution guide ](.github/CONTRIBUTING.md ), if you would like to report a bug, ask a question, translate the app or help us with coding.
2021-02-18 20:20:03 +01:00
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.
2021-01-21 12:04:35 +01:00
## Code of Conduct
Help us keep Cryptomator open and inclusive. Please read and follow our [Code of Conduct ](.github/CODE_OF_CONDUCT.md ).
2021-02-08 15:29:51 +01:00
## 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}:)`
1. Merge translations
1. Check latest dependencies
1. Create release branch
1. Test database migration
1. Smoke-Test changed or added functionality
1. Update version
1. Create and commit release notes
2021-02-18 20:20:03 +01:00
1. Merge in `main`
2021-02-08 15:29:51 +01:00
1. Create tag and execute deploy app using Fastlane
1. Close GitHub-issues or move them to next milestone
1. Close milestone
2021-02-09 14:33:52 +01:00
1. Update version on website ([cryptomator.org/android ](https://cryptomator.org/android/ ))
2021-02-08 15:29:51 +01:00
### Release Notes
2021-02-17 16:22:01 +01:00
Before tagging the release, create and commit the release notes. For Playstore create [fastlane/metadata/android/de-DE/changelogs/default.txt ](https://github.com/cryptomator/android/blob/develop/fastlane/metadata/android/de-DE/changelogs/default.txt ), [fastlane/metadata/android/en-US/changelogs/default.txt ](https://github.com/cryptomator/android/blob/develop/fastlane/metadata/android/en-US/changelogs/default.txt ) and for the website create [fastlane/release-notes.html ](https://github.com/cryptomator/android/blob/develop/fastlane/release-notes.html ).
2021-02-08 15:29:51 +01:00
### 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 ](https://github.com/cryptomator/android/blob/develop/fastlane/README.md )
### Initial setup Fastlane
1. Make sure you copied `.default.env` to `.env` in the `fastlane` folder and filled out those variables.
1. Install Ruby (depends on OS, Ubuntu): `sudo apt install ruby-dev`
1. Install fastlane (depends on OS, Ubuntu): `gem install fastlane -N`
2021-03-02 10:13:38 +01:00
1. Install `fdroidserver` using `apt` , `pacman` , ..., see https://f-droid.org/docs/Installing_the_Server_and_Repo_Tools/
2021-02-08 15:29:51 +01:00
2020-12-21 15:52:03 +01:00
## 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.
