Skip to content

About

Overlayfs fork featuring WebUI

Resources

Stars

43 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

30 Commits

Folders and files

Repository files navigation

Overlayfsx

Build Status License

Overlayfsx is an advanced evolution of the original KernelSU overlayfs metamodule. It introduces a modern WebUI, robust image management, and a real-time kernel mount inspector to handle modules efficiently using an ext4 image overlay.

✨ Key Features

1. πŸ–₯️ Modern WebUI

A comprehensive dashboard integrated directly into KernelSU Manager.

  • Dashboard: Multi-segment donut chart visualizing per-partition storage usage, live mount status, and system stats with ambient themed backgrounds.
  • Module Manager: Redesigned slab cards with real-time file counts and conflict detection sourced directly from the kernel. Search, filter, enable/disable, uninstall, and drill down into per-file conflict resolution.
  • Tools: Syntax-highlighted log viewer with copy/refresh, one-tap storage optimization (hole punching), and self-uninstall/restore capability.
  • Design: Dark glassmorphism theme with Outfit + DM Mono typefaces, per-page orb backgrounds, swipe navigation, and responsive layout.

2. πŸ›‘οΈ Robust Architecture

  • Dual-Directory: Keeps metadata (props, disable flags) in /data/adb/modules and content in a mounted ext4 image.
  • Auto-Repair: Automatically cleans up orphaned modules and "skip_mount" artifacts on boot.
  • First-Time Sync: Interactive volume-key prompt during initial install to migrate existing modules into the ext4 image.
  • Universal Binary: Auto-selects aarch64 or x86_64 binary during installation.

3. ⚑ Real-Time Kernel Inspector

  • No Guessing: Queries /proc/mounts directly from the Linux kernel to extract the exact lowerdir chains currently being enforced.
  • Conflict Resolution: Identifies exactly which module "wins" and which are "shadowed" for every overlaid file, with drill-down into per-file path details.
  • Dual Output: Human-readable tree format for CLI or structured JSON (inspect -r) for WebUI integration.
  • Deduplication: Filters out visually identical conflicts caused by Android symlinks.

4. ⚑ Storage Optimization

  • Smart Management: Uses sparse files for the module image.
  • Optimization Tool: Built-in xcp command punches holes in the image file, reclaiming disk space from deleted modules without destroying the image.

πŸ“₯ Installation

  1. Download the latest overlayfsx-v*.zip from Releases.
  2. Install via KernelSU Manager OR via ADB:
adb push overlayfsx-v1.3.4.zip /sdcard/
adb shell su -c 'ksud module install /sdcard/overlayfsx-v1.3.4.zip'
  1. Reboot.

πŸš€ Usage

Accessing the WebUI

  1. Open KernelSU Manager.
  2. Go to the Modules tab.
  3. Find OverlayFS Enhanced.
  4. Click the WebUI button.

Real-Time Mount Inspection

View exactly what the kernel is enforcing right now:

# Human-readable tree output
/data/adb/modules/meta-overlayfsx/overlayfsx inspect

# Structured JSON for scripts or WebUI
/data/adb/modules/meta-overlayfsx/overlayfsx inspect -r

Storage Optimization

Reclaim disk space from deleted or updated modules (requires reboot for size changes to appear in file managers):

/data/adb/modules/meta-overlayfsx/overlayfsx xcp <src> <dst> --punch-hole

Or use the one-tap Optimize Storage button in the WebUI Settings page.

πŸ—οΈ Building

Requirements: cargo, cargo-ndk, cross (optional).

# Build locally (Artifacts will be in target/module/)
./build.sh

πŸ‘₯ Credits & Acknowledgements

Fork Maintainer

  • AshBorn (@RipperHybrid) β€” WebUI development, kernel inspector, module sync, UI/UX design, and ongoing maintenance.

Original Base Project

Huge thanks to the original creators who built the Meta OverlayFS foundation:

Open Source

This project uses components from:

  • hole-punch (Rust crate)
  • rustix & procfs

πŸ“„ License

Licensed under GPL-3.0.


πŸ“ Reporting Issues

Important: This is a modified fork. Please report bugs related to the WebUI, kernel inspector, module sync, or any fork-specific features to @RipperHybrid. Do not report issues with this fork to the original KernelSU maintainers.

About

Overlayfs fork featuring WebUI

Resources

Stars

43 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages