History

Julien Fontanet 1b35fddf3d feat(@xen-orchestra/fs): 4.1.4		2024-01-31 17:16:15 +01:00
..
.npmignore	feat: implement file restore on top of FUSE instead of vhdimount (#6409 )	2022-09-20 11:04:24 +02:00
.USAGE.md	feat(fuse-vhd): implement cli (#7310 )	2024-01-23 17:14:18 +01:00
cli.mjs	feat(fuse-vhd): implement cli (#7310 )	2024-01-23 17:14:18 +01:00
index.mjs	fix(fuse-vhd): potential race condition in mount/unmount (#7312 )	2024-01-16 18:27:30 +01:00
package.json	feat(@xen-orchestra/fs): 4.1.4	2024-01-31 17:16:15 +01:00
README.md	feat(fuse-vhd): implement cli (#7310 )	2024-01-23 17:14:18 +01:00

README.md

@vates/fuse-vhd

Install

Installation of the npm package:

npm install --save @vates/fuse-vhd

Usage

Mount a vhd generated by xen-orchestra to filesystem

Library

import { mount } from 'fuse-vhd'

// return a disposable, see promise-toolbox/Disposable
// unmount automatically when disposable is disposed
// in case of differencing VHD, it mounts the full chain
await mount(handler, diskId, mountPoint)

cli

From the install folder :

cli.mjs <remoteUrl> <vhdPathInRemote> <mountPoint>

After installing the package

xo-fuse-vhd <remoteUrl> <vhdPathInRemote> <mountPoint>

remoteUrl can be found by using cli in @xen-orchestra/fs , for example a local remote will have a url like file:///path/to/remote/root

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

report any issue you've encountered;
fork and create a pull request.