https://github.com/paulrobello/parfuse

NodeJs in memory Fuse filesystem written in Typescript
https://github.com/paulrobello/parfuse

example fuse fuse-filesystem nodejs typescript

Last synced: about 1 month ago
JSON representation

NodeJs in memory Fuse filesystem written in Typescript

• Host: GitHub
• URL: https://github.com/paulrobello/parfuse
• Owner: paulrobello
• License: mit
• Created: 2021-03-08T20:01:15.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-08-04T16:51:59.000Z (over 3 years ago)
• Last Synced: 2024-12-02T09:44:33.493Z (about 1 month ago)
• Topics: example, fuse, fuse-filesystem, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 167 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**ParFuse FS** is an example in memory filesystem written in Typescript that attempts to implement all Fuse callbacks 

implemented by the [fuse-friends/fuse-native](https://github.com/fuse-friends/fuse-native) package.

Note for custom INode, Devices file types, or SUID to work you must use 

[my fork of the fuse-native package](https://github.com/paulrobello/fuse-native) and run as a privileged user.

My fork also has support for WinFsp copied from [SandruSebastian/fuse-native](https://github.com/SandruSebastian/fuse-native).

This filesystem implements **very** basic INode and file descriptor tracking.

General utilities are located in _utils.ts_. Fuse or filesystem related items are in fuseUtils.ts. Fortune example items  

are located in _fortune.ts_. The main entry point is _index.ts_.

This project attempts to mount the filesystem on _mnt_ in the same folder as the running script. There is an option to 

auto create the folder if it does not exist.

The system will allow up to 75% of available NodeJs heap memory to be used by files.

It simulates blocks as 4KB blocks which is the minimum any nonempty file will occupy.

ParFuse also has a mechanism to issue commands to the filesystem by writing to _/proc/cmd_.

Contents in /proc/cmd are processed line by line.

Current supported commands are:

- delay timeMs  will delay execution of the next commands for timeMs milliseconds.

- newFortune will create or overwrite the file named fortune in the root of the fs with a random quote obtained from 

  [ruanyf/fortunes](https://raw.githubusercontent.com/ruanyf/fortunes/master/data/fortunes)  

There are some helper functions named _mntChroot_ and _unmountChroot_ that will handle mounting the needed folders from 

the host onto the ParFuse fs to allow you to chroot into the virtual filesystem and run things such as _bash_.

You must be using a privileged user to use these functions.

Most files in this project have a debugLevel const at the top of the file which will when set to 'trace' will enable 

lots of debug output. Trace mode is set by an environment variable named "trace" being set to "1".

Have fun and please give feedback!

### License ###

This content is released under the (http://opensource.org/licenses/MIT) MIT License.