0.0.2 • Published 2 years ago

hyperserve v0.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

hyperserve

serve hyperdrives over hyperswarm and http

Hyperserve({ corestore = undefined, storageDir = undefined, key = undefined, hyperdriveOpts = undefined, swarmOpts = undefined } = {} )

usage

hyperserve /path/to/hyperdrive/corestore

Publish one file to hyperdrive

hyperserve publish /path/to/hyperdrive/corestore /url/path/on/hyperdrive /filesystem/path/to/file

Publish directory and all its contents to hyperdrive

hyperserve publish -r /path/to/hyperdrive/corestore /url/base-path/on/hyperdrive /filesystem/path/to/directory
hyperserve serve /path/to/hyperdrive/corestore /url/to/serve/over/http

For example hyperserve serve /blogs serves your blogs and child directories at http://localhost:8080/blogs

For convenience use a configuration file in the current directory:

In hyperserve.json

{
  "storageDir": "storage",
  "serve": "/blogs"
}

Replication

A typical usecase: hyperdrive on local machine to publish blogs to. Hyperserve on a cloud server to serve the content. The cloud server needs to replicate the content from your local machine, to do this it needs the hyperdrive key.

On local machine

hyperserve serve ./storage

On remote machine use the key output above

hyperserve serve --key=2d928cced3bcfb883f044f7a257a611bd973e91a60599d1bda74d7f94bffd881 ./storage

ALternatively, use a hyperserve.json config file on the remote machine. Port can also be set.

{
  "storageDir": "storage",
  "serve": "/blogs",
  "key": "2d928cced3bcfb883f044f7a257a611bd973e91a60599d1bda74d7f94bffd881",
  "port": 3000
}