Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions source/_static/css/overrides.css
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,10 @@ border-color: #407F41;

.rst-content .note, .rst-content .seealso, .rst-content .wy-alert-info.admonition, .rst-content .wy-alert-info.admonition-todo, .rst-content .wy-alert-info.attention, .rst-content .wy-alert-info.caution, .rst-content .wy-alert-info.danger, .rst-content .wy-alert-info.error, .rst-content .wy-alert-info.hint, .rst-content .wy-alert-info.important, .rst-content .wy-alert-info.tip, .rst-content .wy-alert-info.warning, .wy-alert.wy-alert-info {
background: #EBF5EB;
}

.rst-content .highlights {
margin-left: 0;
padding: 0 0.5em;
border-left: 0.25em solid #66CC68;
Comment thread
JaniruTEC marked this conversation as resolved.
}
26 changes: 26 additions & 0 deletions source/_static/csv/clouds-with-webdav-support.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
"Cloud Service","URL"
"1&1 Online-Speicher (DSL)","``https://sd2dav.1und1.de``"
"1&1 Online-Speicher (Webhosting)","``https://webdav.office.1und1.de``"
"blaucloud","``https://{username}.blaucloud.de/remote.php/webdav``"
"Disroot [#note-disroot]_","``https://cloud.disroot.org/remote.php/webdav/``"
"freenetcloud","``https://webmail.freenet.de/webdav``"
"GMX MediaCenter","``https://webdav.mc.gmx.net``"
"HiDrive IONOS [#note-hidrive-ionos]_","``https://webdav.hidrive.ionos.com``"
"HiDrive Strato [#note-hidrive-strato]_","``https://webdav.hidrive.strato.com``"
"IceDrive [#note-icedrive]_","``https://webdav.icedrive.io/``"
"kDrive [#note-kdrive]_","``https://connect.drive.infomaniak.com``"
"Koofr [#note-koofr]_","``https://app.koofr.net/dav/Koofr``"
"MagentaCLOUD [#note-magentacloud]_","``https://magentacloud.de/remote.php/webdav``"
"Mailbox.org","``https://dav.mailbox.org/servlet/webdav.infostore/``"
"Mail.Ru","``https://webdav.cloud.mail.ru``"
"Nextcloud [#note-nextcloud]_","``https://{host}/{path}/remote.php/dav/files/{username}``"
"ownCloud [#note-owncloud]_","``https://{host}/{path}/remote.php/webdav``"
"pCloud (EU) [#note-pcloud]_","``https://ewebdav.pcloud.com``"
"pCloud (US) [#note-pcloud]_","``https://webdav.pcloud.com``"
"Seafile (self-hosted)","``https://{host}/{path}/seafdav``"
"STACK","``https://{username}.stackstorage.com/remote.php/webdav``"
"SWITCHdrive","``https://drive.switch.ch/remote.php/dav/files/{username}``"
"Syncwerk (formerly Seafile.de)","``https://app.syncwerk.com/seafdav``"
"WEB.DE Online-Speicher","``https://webdav.smartdrive.web.de``"
"wölkli","``https://cloud.woelkli.com/remote.php/webdav``"
"Yandex.Disk [#note-yandex-disk]_","``https://webdav.yandex.com``"
2 changes: 2 additions & 0 deletions source/_static/csv/incompatible-clouds.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
"Cloud Service","Android Feature request","iOS Feature request"
"Mega","`#39 <https://github.com/cryptomator/android/issues/39>`_","`#258 <https://github.com/cryptomator/ios/issues/258>`_"
11 changes: 11 additions & 0 deletions source/_static/csv/natively-supported-clouds.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
"Cloud Service","Android [#playstore-recommendation]_","iOS"
"Dropbox","✅ [#except-f-droid-main]_","✅"
"Google Drive","✅ [#except-f-droid-main]_ [#except-f-droid-cryptomator]_","✅"
"OneDrive","✅ [#except-f-droid-main]_","✅"
"pCloud","✅ [#except-f-droid-main]_","✅"
"S3","✅","✅"
"Box.com","❌","✅"
"iCloud","❌","✅"
"Local device storage","✅","✅"
"Spaces provided by other apps [#note-app-spaces]_","✅","✅"
"WebDAV [#note-webdav]_","✅","✅"
5 changes: 3 additions & 2 deletions source/android/cloud-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Please enter the credentials for your provider account or in case of Google Driv
If your authentication was successful, some of the providers might ask you to grant Cryptomator access permission to your online files.
Please allow this permission.

In Google Drive, OneDrive and Dropox you can only create one connection between your cloud storage account and the Cryptomator app.
In Google Drive, OneDrive and Dropbox you can only create one connection between your Cloud Service account and the Cryptomator app.
You can't connect to (for example) two different *Dropbox* accounts.

If the provider requested permission to access your online files you can remove Cryptomator permissions from your online storage account at any time.
Expand Down Expand Up @@ -60,7 +60,8 @@ Login OneDrive
Login WebDAV
------------------

You can find `here <https://community.cryptomator.org/t/webdav-urls-of-common-cloud-storage-services/75>`_ a list of the most common WebDAV URLs.
Please see :ref:`misc/supported-cloud-services/clouds-with-webdav-support` for a non-exhaustive list of Cloud Services
and information about accessing them with WebDAV.

.. image:: ../img/android/add-webdav-login-provider-0.png
:alt: How to handle cloud services with Android
Expand Down
6 changes: 3 additions & 3 deletions source/android/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ After pressing the three dots ① and clicking on ``Settings``, you will find op
Cloud Services
^^^^^^^^^^^^^^

This setting lists all cloud services. When pressing on a service, the authentication starts or if you're already authenticated, you will be logged out.
This setting lists all Cloud Services. When pressing on a service, the authentication starts or if you're already authenticated, you will be logged out.

.. image:: ../img/android/setting-cloud-services.png
:alt: How to handle cloud services with Android
Expand Down Expand Up @@ -212,7 +212,7 @@ If so it will not be downloaded again but directly retrieved from the file syste
Cache Size Per Cloud
^^^^^^^^^^^^^^^^^^^^^^^^^^

Using this setting, you can specify the total max cache size per cloud provider.
Using this setting, you can specify the total max cache size per Cloud Service.

You can choose between the following options:

Expand Down Expand Up @@ -276,7 +276,7 @@ Version

This setting displays the current version of this app.

The following sub settings are only available, if you're using the APK-Store version of Cryptomator and not the PlayStore one.
The following sub settings are only available, if you're using the APK-Store variant of Cryptomator and not the Google Play Store one.

.. _android/settings/update-check-interval:

Expand Down
120 changes: 80 additions & 40 deletions source/android/setup.rst
Original file line number Diff line number Diff line change
@@ -1,80 +1,113 @@
.. role:: raw-html(raw)
:format: html

Setup
=====

You can get Cryptomator for Android on

* `Google Play <https://play.google.com/store/apps/details?id=org.cryptomator&hl=en>`_
* `APK Store <https://cryptomator.org/android/>`_
* `Cryptomator F-Droid repository <https://static.cryptomator.org/android/fdroid/repo?fingerprint=F7C3EC3B0D588D3CB52983E9EB1A7421C93D4339A286398E71D7B651E8D8ECDD>`_
* `Main F-Droid repository <https://f-droid.org/en/packages/org.cryptomator.lite>`_
* `Google Play Store`_
* `APK Store`_
* `Cryptomator F-Droid repository`_
* `Main F-Droid repository`_

No matter which variant of the app you choose: The key functionality of Cryptomator stays the same.

| The variants only differ in terms of the :ref:`supported Cloud Services,<misc/supported-cloud-services>` the way they are downloaded and the way a license is acquired.
If you have access to the *Google Play Store* on your device, **we recommend using the** |GooglePlayStoreVariant|_ **of Cryptomator.**
| Otherwise, please keep reading.

As for the functionality of Cryptomator, the application does not differ using Google Play or the APK Store as installation type. Google Drive is excluded from the F-Droid version because Google Drive needs proprietary dependencies which doesn’t fit to the spirit of F-Droid.
.. _android/setup/variant-differences:

The APK Store and F-Droid variant of Cryptomator was created to serve users who do not have Google PlayStore installed on their Android device.
If you have a Google PlayStore on your device, we recommend using the PlayStore version of Cryptomator.
Differences between variants and how to choose
----------------------------------------------

.. csv-table:: Cryptomator for Android variants
:header: "", ":ref:`Google Play <android/setup/google-playstore>`", ":ref:`APK Store <android/setup/apk-store>`", ":ref:`Cryptomator F-Droid repo <android/setup/f-droid-repository>`", ":ref:`Main F-Droid repo <android/setup/f-droid-main-repository>`"
While all variants of the Cryptomator for Android app have the same key functionality, you should make sure to pick
the perfect variant for you:

"Dropbox", "✅", "✅", "✅", "❌¹"
"Google Drive", "✅", "✅", "❌²", "❌¹"
"OneDrive", "✅", "✅", "✅", "❌¹"
"pCloud", "✅", "✅", "✅", "❌¹"
"WebDAV", "✅", "✅", "✅", "✅"
"S3", "✅", "✅", "✅", "✅"
"Local Storage", "✅", "✅", "✅", "✅"
Most users will want to use the :ref:`Google Play Store<android/setup/google-playstore>` or the :ref:`APK Store<android/setup/apk-store>` as installation type. Both variants have access to all
:ref:`supported Cloud Services<misc/supported-cloud-services>` and allow for maximum flexibility. While the *Google Play Store variant* can be purchased and downloaded via its
*Google Play Store* page, the *APK Store variant* and the accompanying license must be obtained via our website.

❌¹: Excluded because they require API keys. :raw-html:`<br />`
❌²: Excluded because they contains proprietary dependencies.
| The :ref:`Cryptomator F-Droid repo variant<android/setup/f-droid-repository>` and :ref:`Main F-Droid repo variant<android/setup/f-droid-main-repository>` both **don't** support Google Drive as Cloud Service because
Google Drive requires proprietary dependencies which doesn’t fit the spirit of F-Droid.
Additionally the *Main F-Droid repo variant* **doesn't** support **any** Cloud Services that require an API key.
| Both can be downloaded from their corresponding F-Droid repository and require a license which can be obtained via
`our website. <APK Store_>`_
| The *APK Store* and *F-Droid variants* of Cryptomator were created to serve users who do not have the *Google Play Store* installed
on their Android device or do not want their purchases to go through Google.

.. note::
If you have access to the *Google Play Store* on your device, **we recommend using the** |GooglePlayStoreVariant|_ **of Cryptomator**
for the best user experience and maximum flexibility.

To learn more about the supported Cloud Services, please see :ref:`Supported Cloud Services.<misc/supported-cloud-services>`

.. _android/setup/google-playstore:

Google PlayStore
Google Play Store
------------------

If you have installed Cryptomator via the Google PlayStore, you will receive updates as usual via the Google PlayStore.
.. highlights::
| You can buy and download the *Google Play Store variant* of Cryptomator here:
| `Google Play Store`_

If you have installed Cryptomator via the *Google Play Store,* you will receive updates as usual via the *Google Play Store.*

After buying the app using Google PlayStore, it can be used with any number of devices that you have linked to the google account from your purchase. Furthermore it supports the "Google Play Family Library" function which means that the app can be used by up to 5 people in a family without having to buy it again. The conditions and how to create a “Google Play Family” can be found here: https://support.google.com/googleplay/answer/7007852?hl=en
After buying the app using the *Google Play Store,* it can be used with any number of devices that you have linked to the google account from your purchase. Furthermore it supports the "Google Play Family Library" function which means that the app can be used by up to 5 people in a family without having to buy it again. The conditions and how to create a “Google Play Family” can be found here: https://support.google.com/googleplay/answer/7007852?hl=en

Sometimes the Google PlayStore has problems to recognize that the app was already bought and asks you to buy again the app, see this topic to recover from this problem: `On how many devices can the app be installed using Google Play Store? <https://community.cryptomator.org/t/on-how-many-devices-can-the-app-be-installed-using-google-play-store/6129>`_
Sometimes the *Google Play Store* has problems to recognize that the app was already bought and asks you to buy again the app, see this topic to recover from this problem: `On how many devices can the app be installed using Google Play Store? <https://community.cryptomator.org/t/on-how-many-devices-can-the-app-be-installed-using-google-play-store/6129>`_

.. _android/setup/apk-store:

APK Store
------------

The APK store version can be installed from our website `https://cryptomator.org/android/ <https://cryptomator.org/android/>`_. Please verify the `SHA256 Signature` after downloading the APK before installing. The download is a so-called `APK` (Android application package), which is an installation archive. Install the app by simply clicking on the APK.
.. highlights::
| You can buy a license for the app and download the *APK Store variant* of Cryptomator here:
| `APK Store`_

The *APK store variant* can be installed from the `APK Store`_ on our website. Please verify the `SHA256 Signature` after downloading the APK before installing. The download is a so-called `APK` (Android application package), which is an installation archive. Install the app by simply clicking on the APK.

It is possible that the app in which you clicked on the APK is asking for "Install from Unknown Sources" permission, this is normal and must be activated for a short time (it is recommended to remove the permission afterwards).

This version does include an automatic updater that periodically checks if there is a newer version of this app, and if so, it can be downloaded and installed directly from within the app. Using the :ref:`Update Check Interval <android/settings/update-check-interval>` in the Cryptomator settings, you can specify how often the update check is executed.
This variant does include an automatic updater that periodically checks if there is a newer version of this app, and if so, it can be downloaded and installed directly from within the app. Using the :ref:`Update Check Interval <android/settings/update-check-interval>` in the Cryptomator settings, you can specify how often the update check is executed.

As this version wasn't bought using Google's PlayStore you need to buy a license key from our website `https://cryptomator.org/android/ <https://cryptomator.org/android/>`_. After Cryptomator is installed, you have to enter this key. This can be done by copying and pasting the license into the field when asked for it or by clicking on the link starting with `cryptomator://license/YOUR_LICENSE_KEY`.
As this variant is not bought using the *Google Play Store* you need to buy a license key from the `APK Store`_ on our website. After Cryptomator is installed, you have to enter this key. This can be done by copying and pasting the license into the field when asked for it or by clicking on the link starting with ``cryptomator://license/YOUR_LICENSE_KEY``.

.. _android/setup/f-droid-repository:

Cryptomator F-Droid repository
--------------------------------

The Cryptomator F-Droid repository version can be installed after adding our F-Droid repository to the F-Droid app by opening `this link <https://static.cryptomator.org/android/fdroid/repo?fingerprint=F7C3EC3B0D588D3CB52983E9EB1A7421C93D4339A286398E71D7B651E8D8ECDD>`_ on the device or scanning the following QR-Code:
.. highlights::
| You can buy a license for the *Cryptomator F-Droid repository variant* of Cryptomator here:
| `APK Store`_

.. highlights::
| You can download the *Cryptomator F-Droid repository variant* of Cryptomator from F-Droid after adding our F-Droid
repository to the F-Droid app by opening this link on the device or by scanning the following QR-Code:
| `Cryptomator F-Droid repository`_

.. image:: ../img/android/fdroid-qr-code.svg
:alt: How to handle cloud services with Android
:width: 128px
.. image:: ../img/android/fdroid-qr-code.svg
:alt: How to handle cloud services with Android
:width: 128px
Comment thread
JaniruTEC marked this conversation as resolved.

As well as using the APK Store variant because this app version wasn't bought using Google's PlayStore you need to buy a license key from our website `https://cryptomator.org/android/ <https://cryptomator.org/android/>`_. After Cryptomator is installed, you have to enter this key. This can be done by copying and pasting the license into the field when asked for it or by clicking on the link starting with `cryptomator://license/YOUR_LICENSE_KEY`.
As with the *APK Store variant,* since this app variant is not purchased via the *Google Play Store,* you need to buy a license key from the `APK Store`_ on our website. After Cryptomator is installed, you have to enter this key. This can be done by copying and pasting the license into the field when asked for it or by clicking on the link starting with ``cryptomator://license/YOUR_LICENSE_KEY``.

.. _android/setup/f-droid-main-repository:

Main F-Droid repository
------------------------

The Main F-Droid repository version can be installed directly from the `Main F-Droid repository <https://f-droid.org/en/packages/org.cryptomator.lite>`_. Regarding the license key, the same applies as with the :ref:`Cryptomator F-Droid repository <android/setup/f-droid-repository>` variant.
.. highlights::
| You can buy a license for the *Main F-Droid repository variant* of Cryptomator here:
| `APK Store`_

.. highlights::
| You can download the *Main F-Droid repository variant* of Cryptomator here:
| `Main F-Droid repository`_

Unlike all other versions of Cryptomator for Android, this version has its own package name: ``org.cryptomator.lite``. It means that you cannot, intentionally or unintentionally, simply switch between this and the other versions. It requires to setup the app again. The reason we decided to do this is that other Cryptomator variants already exist in some popular F-Droid repositories, and if we hadn't decided to do this, there could have been an unwanted variant switch.
The *Main F-Droid repository variant* can be installed directly from the `Main F-Droid repository. <Main F-Droid repository_>`_ Regarding the license key, the same applies as with the :ref:`Cryptomator F-Droid repository variant.<android/setup/f-droid-repository>`

Unlike all other variants of Cryptomator for Android, this variant has its own package name: ``org.cryptomator.lite``. It means that you cannot, intentionally or unintentionally, simply switch between this and the other variants. It requires to setup the app again. The reason we decided to do this is that other Cryptomator variants already exist in some popular F-Droid repositories, and if we hadn't decided to do this, there could have been an unwanted variant switch.

.. _android/setup/requirements:

Expand All @@ -88,10 +121,17 @@ Requires Android 8.0 or later.
Update Rollout
---------------

The timing of the update depends on your installation type:
The timing of the update depends on your installed variant:

* *Google Play Store:* Updates are reviewed by Google, so it may take a few days before the update is available.
* *APK Store:* Updates are available as they are released.
* *Cryptomator F-Droid Repo:* Updates are available as they are released.
* *Main F-Droid Repo:* Updates are available as soon as the F-Droid maintainers have built the application, which can take a few days.

* Google PlayStore: Updates are reviewed by Google, so it may take a few days before the update is available.
* APK Store: Updates are available as they are released.
* Cryptomator F-Droid Repo: Updates are available as they are released.
* Main F-Droid Repo: Updates are available as soon as the F-Droid maintainers have built the application, which can take a few days.
.. _`Google Play Store`: https://play.google.com/store/apps/details?id=org.cryptomator&hl=en
.. _`APK Store`: https://cryptomator.org/android/
.. _`Cryptomator F-Droid repository`: https://static.cryptomator.org/android/fdroid/repo?fingerprint=F7C3EC3B0D588D3CB52983E9EB1A7421C93D4339A286398E71D7B651E8D8ECDD
.. _`Main F-Droid repository`: https://f-droid.org/en/packages/org.cryptomator.lite

.. |GooglePlayStoreVariant| replace:: **Google Play Store variant**
.. _GooglePlayStoreVariant: `android/setup/google-playstore`_
Loading