Co-authored-by: weishu <twsxtd@gmail.com> Co-authored-by: YuKongA <70465933+YuKongA@users.noreply.github.com> Co-authored-by: Ylarod <me@ylarod.cn>
59 lines
1.5 KiB
Markdown
59 lines
1.5 KiB
Markdown
# meta-overlayfs
|
|
|
|
Official overlayfs mount handler for KernelSU metamodules.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
adb push meta-overlayfs-v1.0.0.zip /sdcard/
|
|
adb shell su -c 'ksud module install /sdcard/meta-overlayfs-v1.0.0.zip'
|
|
adb reboot
|
|
```
|
|
|
|
Or install via KernelSU Manager → Modules.
|
|
|
|
**Note**: The metamodule is now installed as a regular module to `/data/adb/modules/meta-overlay/`, with a symlink created at `/data/adb/metamodule` pointing to it.
|
|
|
|
## How It Works
|
|
|
|
Uses dual-directory architecture for ext4 image support:
|
|
|
|
- **Metadata**: `/data/adb/modules/` - Contains `module.prop`, `disable`, `skip_mount` markers
|
|
- **Content**: `/data/adb/metamodule/mnt/` - Contains `system/`, `vendor/` etc. directories from ext4 images
|
|
|
|
Scans metadata directory for enabled modules, then mounts their content directories as overlayfs layers.
|
|
|
|
### Supported Partitions
|
|
|
|
system, vendor, product, system_ext, odm, oem
|
|
|
|
### Read-Write Layer
|
|
|
|
Optional upperdir/workdir support via `/data/adb/modules/.rw/`:
|
|
|
|
```bash
|
|
mkdir -p /data/adb/modules/.rw/system/{upperdir,workdir}
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
- `MODULE_METADATA_DIR` - Metadata location (default: `/data/adb/modules/`)
|
|
- `MODULE_CONTENT_DIR` - Content location (default: `/data/adb/metamodule/mnt/`)
|
|
- `RUST_LOG` - Log level (debug, info, warn, error)
|
|
|
|
## Architecture
|
|
|
|
Automatically selects aarch64 or x86_64 binary during installation (~500KB).
|
|
|
|
## Building
|
|
|
|
```bash
|
|
./build.sh
|
|
```
|
|
|
|
Output: `target/meta-overlayfs-v1.0.0.zip`
|
|
|
|
## License
|
|
|
|
GPL-3.0
|