aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 2cf74018c93fcca1941a5508641a9c00a60b92fa (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# Multi-Mount

## Description

This Magisk module mounts one or more filesystems (e.g. CIFS/SMB, NFS, etc.).

This is a fork of [https://github.com/clifforama/multi-mount](https://github.com/clifforama/multi-mount).
It adds support for additional `su` parameters.


## Requirements

- Magisk v20.4+

- Kernel support for filesystem(s) to be mounted (hint: `grep cifs /proc/filesystems`)



## Instructions

1. Create config file(s) with filename(s) ending in `.conf` and place them in `/sdcard/.multi-mount` (i.e. the
   `.multi-mount` directory resides in the same directory that typically contains DCIM, Documents, Download, etc.). Each
   config file corresponds to a distinct mount configuration and must adhere to the following example:

        mount_options="-t cifs -o vers=2.0,username=user,password=pass"
        mount_source="//host/share"
        mount_target="/mnt/cifs-share"
        mount_max_retries=20
        mount_retry_interval=15s

2. Install module via Magisk Manager, then reboot.



## Notes

- Every distinct mount requires its own config file. So, to mount multiple CIFS shares, create multiple config files
  (e.g. `cifs-1.conf`, `cifs-2.conf`, etc.). Filenames are arbitrary, but must end in `.conf`.

- Config files are read at boot. Reboot for changes to take effect.

- In order to mount a network share, the network must be reachable after boot within the timeframe defined by
  `mount_max_retries` and `mount_retry_interval`.

- If mounting a CIFS share fails, try specifying a different CIFS version.

- While any filesystem supported by the kernel should work, Multi-Mount has only been tested with CIFS on [KonstaKANG's
  LineageOS 18.1 Android TV (Android 11) for Raspberry Pi 4](https://konstakang.com/devices/rpi4/LineageOS18-ATV/),
  release 11.10.