Skip to content

Legacy API: Administration

James Lott edited this page May 8, 2018 · 1 revision

Configuration

The API requires a single configuration file named config.json to be placed in the top level directory. The configuration object accepts the following parameters:

  • listen (required): An object which specifies the address and port to listen for requests on
    • address (optional): IP address to bind to
    • port (required): Port to bind to
  • storage (required): Storage backend specific configuration parameters

A sample configuration:

{
  "listen": {"address": "0.0.0.0", "port": 8080 },
  "storage": { "path": "/path/to/db.sqlite" }
}

Sqlite3 backend

The sqlite3 storage backend requires a single parameter:

  • path (required): Path to sqlite3 database file

Clone this wiki locally