Hypercore Rehost Server

Simple server to keep hypercores available.

A CLI to interact with this server is provided at hypercore-rehost-cli.

Install

npm -g i hypercore-rehost-server

Usage

Note: can be run as Docker, see here.

CLI usage:

rehost-server

By default, the logs are in JSON format. If you wish them to be human-readable, pipe them into pino-pretty (which needs to be installed):

rehost-server | pino-pretty

Endpoints

See also example.js for examples of how to call the server's endpoints.

GET /

List all entries directly contained in the rehoster.

Entries are of the from {key, info?}.

PUT /<public-key>

Add the core with the specified public key (in hex) to the rehoster.

Also accepts optional JSON data of form { info: <str> }

DELETE /<public-key>

Delete the core with the specified public key (in hex) from the rehoster

GET /info

Returns a JSON with keys info and details, and string values.

Info contains a summary of the total nr of hosted keys (including recursively hosted ones).

Details contains basic info for all hosted keys (including recursively hosted ones).

Config

Config variables are specified either in a .env file or as environment variables. They include:

• CORESTORE_LOC = './rehoster-corestore'
  • The location of the corestore where all cores will be stored
• BEE_NAME = 'rehoster-bee'
  • The name of the hyperbee containing the public keys of all hypercores to be rehosted
• LOG_LEVEL = 'info'
• HOST = '127.0.0.1'
  • Address where the server runs
• PORT
  • Port where the server runs