MarMed/com.piyushgarg.rclone

Rclone Remount for Android

Remount cloud storage locally on boot via rclone & fusermount directly on your Android powered smart device.

Virtually limitless storage expansion with support for dozens of cloud providers including Dropbox, GDrive, OneDrive, SFTP & many more. Extremely useful for devices without physical storage expansion capabilities. Also great for streaming large media files without need for full caching. Binaries obtained directly from rclone.org.

We are constantly striving to improve this project & make it the best. If you experience any issues or have suggestions please file them HERE. Contributions to this project are welcomed.

Features

Support for arm, arm64, ~~& x86~~
Huge list of supported cloud storage providers
Apps with ability to specify paths can access /mnt/cloud/
Most file explorers work just fine (issue #9)
Mount points use names of remote(s) in rclone.conf
Specify custom rclone params for each remote via /sdcard/.rclone/.REMOTE.param
Access remotes via http://127.0.0.1:38762
Access remotes via ftp://127.0.0.1:38763
Mount bind to /sdcard/ (see issue #5)

Configuration (pre-installing)

Copy your rclone.conf file to /sdcard/.rclone/rclone.conf (not required)
Add custom params at /sdcard/.rclone/.*.param (if needed)
Install the module via Magisk Manager
Run rclone config via term if additional setup required
All your rclone mount points will show up under /mnt/cloud/ & /storage/cloud/ or /sdcard/cloud/

For more detailed configuration of rclone please refer to official documentation

Custom Params

Specification of rclone parameters on a per remote basis can be created inside hidden files ending with the .param extension

  /sdcard/.rclone/.*.param

Where * is replaced with name of remote

Parameters and their default values:

  BUFFERSIZE=0

  CACHEMAXSIZE=1G

  CACHEINFOAGE=30m

  DIRCACHETIME=1h

  ATTRTIMEOUT=30s

  READAHEAD=128k

  CACHEMODE=off

  DISABLE=0

  READONLY=0

  BINDSD=0

  BINDPOINT=

  ADD_PARAMS=

  REPLACE_PARAMS=

NOTE: There is no need to specify values you do not wish to change. The above are defaults for all remotes. For more information see issue #2

Custom Globals

Specification of global rclone parameters can be created in

  /sdcard/.rclone/.global.param

Global Specific Parameters
```
  NET_CHK=google.com
```
Excluded Parameters
```
  BINDPOINT=
```
NOTE: Global parameters effect all remotes without .*.parm files containing opposing values. Some parameters are specific to globals while others have been excluded

Known Issues

VLC takes a long time to load media as it opens file in write mode when using it's internal browser.

a. Create remote type alias for media dirs in rclone.conf and specify CACHEMODE=off in /sdcard/.rclone/.ALIASNAME.param
Encrypted devices can not mount until unlock
Encrypted rclone.conf causes reboots
High cpu/mem in some apps with storage perms (issue #9)
The fusermount bin may not be compatible on all devices (see thread)

Disclaimer

Neither the author nor developer's will be held responsible for any damage/data loss that may occur during use of this module. While we have done our best to make sure no harm will come about, no guarantees can be made. Keep in mind the binaries included in this project were originally intended to be ran on PCs which may cause unforseen issues.

Credits

rclone devs
pmj_pedro@xda
agnostic-apollo@xda
rclone binaries from rclone.org
fusermount binaries from xda-devs
improvements geofferey@github

Changelog

v1.1

Initial release
rclone mount

v1.2

Change install process
Changes for full systemless
Improve mount reliability
Symlink mountpoint to /storage/

v1.3

Move user rclone.conf & related to /sdcard/.rclone/
Control global --vfs-cache-mode via simple files placed in /sdcard/.rclone/
Specify custom params for individual remotes via /sdcard/.rclone/.REMOTENAME.params

v1.4

Add ability to disable a remote
Add a wrapper script for rclone
Access remotes via http & ftp
Use without rebooting device
Add wrapper cmds to rclone help
Make remount possible via su -M -c

v1.5

Replace arm/arm64 rclone 1.48 bins built with Termux
Replace arm/arm64 fusermount built with Termux
Add arm/arm64 libandroid-support.so from Termux
Support for mounting to SD
Squash missing rclone.conf install bug
Tune default parameters
Include a wrap for rclone config
Include fusermount-wrapper.sh
General Improvements

v1.6

Simplify custom global parameters
Fix & improve binding to SD
Specify additional rclone ops with ADD_PARAMS=
Replace rclone mount ops via REPLACE_PARAMS=

MarMed / com.piyushgarg.rclone