@dhub/ddrive

A companion service for dHub that provides FUSE/CLI access to dDrives.

This service creates a "root drive" for you, which is a single, private dDrive that's mounted at ~/DDrive. You can think of this root drive as a replacement for your normal home directory (where you might have Documents, Videos, and Pictures folders, for example).

The CLI gives you commands for interacting with dDrives, both inside and outside of FUSE. Here are some of the included commands:

• The mount and unmount commands allow you to attach/detach other other dDrives to/from your root drive.
• The seed and unseed commands let you decide whether you'd like to advertise a drive on the dWeb DHT.
• The import and export commands are for users who don't want to use FUSE, but still want to move data in and out of dDrives.

For dDrive Daemon Users

This module replaces the functionality of the ddrive-daemon. If you've previously used that daemon, running dHub for the first time will migrate your content in ~/.ddrive to be compatible with this service.

Also, @dhub/ddrive will only run in the foreground -- we switched to this model to keep things easy to use and debug. If you'd like to run it persistently (such that this service and dHub auto-start on reboot), you can set this up using your system's process manager (like systemd).

Installation

Before installing the dDrive service, you'll want to first install dhub. Once dHub is installed, run:

npm i @dhub/ddrive -g

After the NPM installation, you should have access to the ddrive CLI tool.

Getting Started

In another terminal, spin up dHub by running dhub (no other flags needed).

If you're planning on using FUSE, you have to perform a one-time setup step to do the FUSE installation. This will prompt you for sudo access:

$ ddrive fuse-setup

Once FUSE has been configured, you're ready to start the dDrive service:

$ ddrive start

API

@dhub/ddrive exposes an API for programmatically interacting with your root drive. To create a client:

const DDriveServiceClient = require('@dhub/ddrive/client')
const client = new DDriveServiceClient()

const client = new DDriveServiceClient(opts = {})

Create a new client for interacting with the dDrive service.

If you don't provide any options, options will be loaded from a configuration file inside of the ~/.dhub directory and a dHub client will be created automatically.

Options include:

{
  mnt: string, // The FUSE mountpoint
  key: Buffer, // Your root drive key.
  client: DHubClient // A dhub client.
}

await client.mount(path, opts = {})

Mounts a dDrive inside of your root drive. path must be contained within your root drive's mountpoint (typically ~/DDrive).

Options include all options to dDrive's mount method, such as:

{
  key: Buffer, // The key of the drive you're mounting.
  version: number, // The drive version (if you're creating a static mount)
}

await client.unmount(path)

Unmount the drive mounted at path. path must be contained within your root drive's mountpoint (typically ~/DDrive).

await client.seed(path, opts = {})

Start announcing a mounted drive on the dWeb DHT.

Options include:

{
  remember: boolean, // true if this network configuration should be persisted across restarts.
}

await client.unseed(path, opts = {})

Stop announcing a mounted drive on the dWeb DHT.

Options include:

{
  remember: boolean, // true if this network configuration should be persisted across restarts.
}

await client.info(path)

Returns info about the drive mounted at path.

The info takes the form:

{
  key: Buffer, The drive's key
  discoveryKey: Buffer, // The drive's discovery key.
  writable: boolean, // true if the drive is writable.
  mountPath: string, // The path of the enclosing mountpoint.
  announce: boolean, // true if the drive is currently being announced on the dWeb DHT.
  lookup: boolean    // true if the drive is currently being looked up on the dWeb DHT.
}

await client.stats(path)

Return drive storage/networking statistics.

The stats take the form:

{
   storage, // Storage info about each mountpoint in the drive.
   network, // Networking info about each mountpoint in the drive.
}

where storage has the same structure as that returned by DDrive.stats and network has the form:

{
  '/': {
    metadata: {
      key,
      discoveryKey,
      length: number, // The dDatabase's length,
      byteLength: number // The dDatabase's byteLength
      peers: [Peer] // An Array of dDatabase Peer objects.
    },
    content: {
      // Same as above
      ...
     }
  },
  '/mountpoint1': {
     // Same as above
     ...
  }
}

const { progress, drive } = client.import(key, dir, opts = {})

Imports a dDrive into dHub.

If you're using FUSE, you probably don't need to explictly import/export, because you can replicate this functionality using the filesystem alone.

progress is an instance of mirror-folder. drive is the dDrive that you're importing into.

Options include:

{
  watch: false // Watch for changes.
}

Note: This imported drive will not appear inside your root drive unless you explicitly mount it with ddrive mount (mount path) (imported drive key)

const { progress, drive } = client.export(key, dir, opts = {})

Exports a dDrive into a local directory.

If you're using FUSE, you probably don't need to explictly import/export, because you can replicate this functionality using the filesystem alone.

Options include:

  watch: false // Watch for changes.

CLI Commands

The ddrive CLI tool includes a handful of subcommands that wrap the API methods described above. Running ddrive help will give more complete usage info:

$ ./bin/run/run help
A dHub service that for managing dDrives over FUSE.

VERSION
  @dhub/ddrive/1.0.0 linux-x64 node-v12.9.1

USAGE
  $ ddrive [COMMAND]

COMMANDS
  autocomplete   display autocomplete installation instructions
  create         Create a new drive mounted at the specified path
  export         Export a dDrive into a directory.
  force-unmount  Forcibly unmount the root filesystem (useful if it was not cleanly unmounted).
  fuse-setup     Perform a one-time configuration step for FUSE.
  help           display help for dDrive
  import         Import a directory into a dDrive.
  info           Display information about the drive mounted at the given mountpoint.
  mount          Mount a drive at the specified mountpoint.
  seed           Seed a dDrive on the network.
  start          Start the dDrive service.
  stats          Get the networking stats for the drive mounted at a path.
  unmount        Unmount a drive. The root drive will be unmounted if a mountpoint is not specified.
  unseed         Stop seeding a dDrive on the network.

License

MIT