Skip to content

Latest commit

 

History

History
191 lines (144 loc) · 4.93 KB

README.md

File metadata and controls

191 lines (144 loc) · 4.93 KB
Raw

This tools allows you to mount a Hyperdrive to a local folder using FUSE (Filesystem in UserSpacE).

See https://docs.pears.com/building-blocks/hyperdrive It uses the awesome https://github.com/fuse-friends/fuse-native

Create by Thomas Farstrike thomasverstreken@protonmail.com

Installation

Tested with Node.js v16.17.1 but newer versions should also work.

Install the required dependencies from package.json with:

npm install

Usage

Usage: node fuse-mount-hyperdrive.js mountDir [driveKeyHex]

Example: node fuse-mount-hyperdrive.js mnt1 // to create a new writable hyperdrive, mounted at mnt1/

Example: node fuse-mount-hyperdrive.js mnt2 4b3278fc44e9716c0342715f42e314050a3c825a51056ac53ee8170986a8bb86 // to mount an existing hyperdrive in read-only mode at mnt2/

NOTE: mountDir will be created if they don't exist.

What works

The following low-level filesystem operations are supported:

  • create: creating files
  • read: reading files
  • write: writing files
  • unlink: removing files
  • mkdir: creating directories (including empty ones)
  • rmdir: removing directories
  • readdir: listing directories

Supported operating sytems:

  • Linux (tested on Debian with kernel 4.19.x)
  • MacOS (untested but should work)

TODO's

  • add symbolic link support (if anyone needs it)
  • add executable file support
  • add support for Microsoft Windows operating sytem (if anyone needs it)

Examples

Create a new hyperdrive and mount it

user@pc:~/fuse-mount-hyperdrive$ node fuse-mount-hyperdrive.js mnt1

Mounting drive...
FUSE library version: 2.9.9
nullpath_ok: 0
nopath: 0
utime_omit_ok: 0
unique: 1, opcode: INIT (26), nodeid: 0, insize: 56, pid: 0
INIT: 7.27
flags=0x003ffffb
max_readahead=0x00020000
filesystem mounted on /home/user/fuse-mount-hyperdrive/mnt1
Awaiting initialization...
Awaiting drive readiness...
   INIT: 7.19
   flags=0x00000011
   max_readahead=0x00020000
   max_write=0x00020000
   max_background=0
   congestion_threshold=0
   unique: 1, success, outsize: 40
Use this public key of the Hypercore backing the drive to mount this hyperdrive somewhere else in read-only mode: e855ada003468d1010301ebc6c0effd11f2b4e25b5f2d67245515950e2f93d39
waiting for swarm connection...
swarm connection done.

Now in another terminal, you can see the folder is mounted:

user@pc:~/fuse-mount-hyperdrive$ mount | grep mnt
/dev/fuse on /home/user/fuse-mount-hyperdrive/mnt1 type fuse (rw,nosuid,nodev,relatime,user_id=1000,group_id=1000)

Directory listing:

user@pc:~/fuse-mount-hyperdrive$ ls -al mnt1/`
total 0

Creating and reading files:

user@pc:~/fuse-mount-hyperdrive$ echo TESTING > mnt1/cool
user@pc:~/fuse-mount-hyperdrive$ cat mnt1/cool
TESTING

Creating directories:

user@pc:~/fuse-mount-hyperdrive$ mkdir mnt1/subdir
user@pc:~/fuse-mount-hyperdrive$ ls -al mnt1/
mnt1/:
total 0
-rw-r--r-- 1 user user   8 May  3 14:14 cool
drwxr-xr-x 1 user user 100 May  3 14:14 subdir

Removing directories:

user@pc:~/fuse-mount-hyperdrive$ rm -rf mnt1/subdir/
user@pc:~/fuse-mount-hyperdrive$ ls -al mnt1/
total 0
-rw-r--r-- 1 user user 8 May  3 14:18 cool

Mirror and mount that drive somewhere else:

user@pc:~/fuse-mount-hyperdrive$ node fuse-mount-hyperdrive.js mnt2 e855ada003468d1010301ebc6c0effd11f2b4e25b5f2d67245515950e2f93d39

The new mount point will join the swarm and synchronize the Hyperdrive:

user@pc:~/fuse-mount-hyperdrive$ cat mnt2/cool
TESTING

Mount and list the Keet Hyperdrive:

Mount it:

user@pc:~/fuse-mount-hyperdrive$ node fuse-mount-hyperdrive.js mnt1 4b3278fc44e9716c0342715f42e314050a3c825a51056ac53ee8170986a8bb86

Output:

Mounting drive...
FUSE library version: 2.9.9
nullpath_ok: 0
nopath: 0
utime_omit_ok: 0
unique: 1, opcode: INIT (26), nodeid: 0, insize: 56, pid: 0
INIT: 7.27
flags=0x003ffffb
max_readahead=0x00020000
filesystem mounted on /home/user/fuse-mount-hyperdrive/mnt1
Awaiting initialization...
initializing with driveKey 4b3278fc44e9716c0342715f42e314050a3c825a51056ac53ee8170986a8bb86
Awaiting drive readiness...
   INIT: 7.19
   flags=0x00000011
   max_readahead=0x00020000
   max_write=0x00020000
   max_background=0
   congestion_threshold=0
   unique: 1, success, outsize: 40
waiting for swarm connection...
swarm connection done.

Now in another terminal, do:

user@pc:~/fuse-mount-hyperdrive$ ls -al mnt1/

And you'll see:

total 0
drwxr-xr-x 1 user user  100 May  3 13:58 assets
-rw-r--r-- 1 user user 1687 May  3 13:58 index.html
drwxr-xr-x 1 user user  100 May  3 13:58 node_modules
-rw-r--r-- 1 user user 1921 May  3 13:58 package.json
-rw-r--r-- 1 user user 1297 May  3 13:58 README.md
drwxr-xr-x 1 user user  100 May  3 13:58 scripts
drwxr-xr-x 1 user user  100 May  3 13:58 src
-rw-r--r-- 1 user user 1409 May  3 13:58 switch.js

Support

Don't hesitate to create issues at https://github.com/ThomasFarstrike/fuse-mount-hyperdrive/issues

I'm available through e-mail at thomasverstreken@protonmail.com and for chat at the Holepunch discord @ThomasFarstrike.