Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 479bb412 authored by Nicolas Gelot's avatar Nicolas Gelot
Browse files

Update README

Reworking the README in order to document the eDrive behavior.
Authors and issues are tracked by git and gitlab so I have
removed these information.
parent e9baf294
Loading
Loading
Loading
Loading
Loading
+39 −18
Original line number Diff line number Diff line
## eelo Drive's README
# eDrive

#### Developer(s):
- Vincent (vincent.bourgmayer@e.email)
- Frank
eDrive is a persitent application provided by default with /e/OS.
It synchronizes user's data files to /e/Cloud or a self-hosted cloud.

### Install
## Install

Since the application is persistent, you won't be able to reinstall the app with a regular `adb install -r` command. You will have to `pm uninstall foundation.e.drive` before reinstalling the application.
Since the application is persistent, you won't be able to reinstall
the app with a regular `adb install -r` command. You will have to
`pm uninstall foundation.e.drive` before reinstalling the application.

### Notes:
To disable All the synchronisation, go into your account and disable BOTH: "application settings" AND "Photos and videos"
## Map of synced directories

#### Actu:
Fix account's deletion
Fix disabled sync in account's settings: I update DB, so it might cause issue after update. One solution in this case is to remove your account and add it again.
| device                               | cloud                                  | category     |
| ------------------------------------ | -------------------------------------- | ------------ |
| /storage/emulated/0/DCIM             | /Photos                                | Images       |
| /storage/emulated/0/Pictures         | /Pictures                              | Images       |
| /storage/emulated/0/Movies           | /Movies                                | Movies       |
| /storage/emulated/0/Music            | /Music                                 | Music        |
| /storage/emulated/0/Ringtones        | /Ringtones                             | Ringtones    |
| /storage/emulated/0/Documents        | /Documents                             | Documents    |
| /storage/emulated/0/Podcasts         | /Podcasts                              | Podcasts     |
| /data/system/users/0/                | /Devices/\<id\>/rom_settings/          | Rom settings |
| /data/data/foundation.e.drive/files/ | /Devices/\<id\>/rom_settings/app_list/ | Rom settings |

Check the [wiki](https://gitlab.e.foundation/e/apps/eDrive/wikis/home) for more information
All remote directories are created by eDrive if needed.

#### TODO:
This is the current pending goal List:
## Notes

+ Handle lack of space localy
+ Issue # 0 : apps crash if request are too long and fails because of that
+ Add Unit test
+ ScheduleInitialization while it hasn't run completely or user hasn't disable both sync type.
### How it works

When you register an /e/account the synchronization is enabled by default.
The synchronization is done on `ACTION_SCREEN_OFF` intent if the last
sync is greater than 15 min. Otherwise a sync is scheduled each 30 min.

### Settings

To enable/disable the synchronisation, go into your account settings:

* Application settings (Rom settings)
* Pictures and videos (Images, Movies, Music, Ringtones, Documents and Podcasts)

# Interrobility

eDrive can also receive broadcast intent for forcing the synchronization.

```bash
adb shell am broadcast -a foundation.e.drive.action.FORCE_SYNC
```