UNPKG

vfs

Version:

Experimental SFTP over WebSockets filesystem client running on top of SSHFS

github.com/lukaaash/vfs

lukaaash/vfs

25 lines (17 loc) • 1.36 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
vfs === VFS is an experimental wrapper around [SSHFS](http://fuse.sourceforge.net/sshfs.html) written in Node.js. It makes it possible to mount remote filesystems accessible through [SFTP over WebSockets](http://sftp.ws/) (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 1. Setup an [SFTP over WebSockets server](https://www.npmjs.com/package/sftp-ws/) at the remote machine (or skip this step and try `wss://nuane.com/sftp`). 2. Install `sshfs` at the client (in Debian/Ubuntu, run `apt-get install sshfs` as root). 3. Install `vfs` at the client by running `npm install vfs` (add `-g` as root to install globally). 4. Mount a remote filesystem to a local directory by running `vfs url mountpoint` (for example `vfs 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. 5. 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).