vfs
v0.2.2
Published
Experimental SFTP over WebSockets filesystem client running on top of SSHFS
Downloads
352
Readme
vfs
VFS is an experimental wrapper around SSHFS written in Node.js. It makes it possible to mount remote filesystems accessible through SFTP over WebSockets (instead of common SFTP over SSH).
In future, it might support other kinds of virtual filesystems as well.
Note: At the client side, Linux with sshfs
and Node.js is required.
Getting started
- Setup an SFTP over WebSockets server at the remote machine (or skip this step and try
wss://nuane.com/sftp
). - Install
sshfs
at the client (in Debian/Ubuntu, runapt-get install sshfs
as root). - Install
vfs
at the client by runningnpm install vfs
(add-g
as root to install globally). - Mount a remote filesystem to a local directory by running
vfs url mountpoint
(for examplevfs wss://nuane.com/sftp ~/sftp
). Optionally, add--path=path_name
to specify a remote path if you only wish to mount a part of the remote filesystem. - Enjoy the remote filesystem! :-)
Missing features
- Add the ability to easily start the filesystem client in the background.
- Make it possible to pass SSHFS and FUSE options from command line.
- More authentication options (only
Basic
authentication is supported at the moment, which is insufficient).