FilterFS

A simple filtered passthrough FUSE filesystem in Rust.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

FilterFS is a FUSE-based passthrough filesystem that filters directory listings and file access based on a set of allowed file extensions and directories. It's written in Rust and uses the fuser library for FUSE integration.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Rust

  curl https://sh.rustup.rs | sh

• libfuse-dev

  sudo apt-get install libfuse-dev

Installation

1. Clone the repo

   git clone https://github.com/nullstring1/filterfs.git

2. Build the project

   cargo build --release

(back to top)

Usage

Use the filesystem by running the compiled binary with a source directory, a mount point, and a list of allowed extensions.

./target/release/filterfs <SOURCE_DIRECTORY> <MOUNT_POINT> <EXTENSIONS> [--allowed-dirs <DIRECTORY_LIST>]

For example, to mount the current directory at ~/filtered_view and only allow .txt and .md files, you would run:

./target/release/filterfs . ~/filtered_view txt md

or

To mount current directory at ~/filtered_view and only allow .txt and .md files, and any files under ./excluded_config_files, you would run:

./target/release/filterfs . ~/filtered_view txt md --allowed-dirs ./excluded_config_files

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

NullString1 - ns@nullstring.one

Project Link: https://github.com/nullstring1/filterfs

(back to top)

Acknowledgments

• othneildrew/Best-README-Template

(back to top)