Skip to content

Usage

Before starting the applications, make sure to check out the settings page.
In case of a misconfiguration the application may not start or Worker and Hive may not communicate. If that happens check the command output or logs.

Hive

Use the following to invoke the application:

cryton-hive

You should see a help page:

Usage: cryton-hive [OPTIONS] COMMAND [ARGS]...

  Cryton Hive.

Options:
  ...

To learn about each command's options use:

cryton-hive <your command> --help

To migrate the database and start the application use:

cryton-hive start --migrate-database

REST API is by default running at http://0.0.0.0:8000 (interactive documentation at http://0.0.0.0:8000/doc).

To serve the REST API on a different host/port, use the --bind option:

cryton-hive start --bind <address>:<port>

Run it in the background

Use the nohup command:

nohup cryton-hive start > /tmp/hive_std_out 2>&1 &

To stop it, find its processes and kill them:

ps -aux | grep cryton-hive
kill <PID> <PID>

Worker

Use the following to invoke the application:

cryton-worker

You should see a help page:

Usage: cryton-worker [OPTIONS] COMMAND [ARGS]...

  Cryton Worker.

Options:
  ...

To learn about each command's options use:

cryton-worker <your command> --help

To start the Worker use:

cryton-worker start

Run it in the background

Use the nohup command:

nohup cryton-worker start > /tmp/worker_std_out 2>&1 &

To stop it, find its processes and kill them:

ps -aux | grep cryton-worker
kill <PID> <PID>

CLI

Use the following command to invoke the application:

cryton-cli

You should see a help page:

Usage: cryton-cli [OPTIONS] COMMAND [ARGS]...

  Wrapper for Hive's REST API.

Options:
  ...

To learn about each command's options use:

cryton-cli <your command> --help