hivemind-app-backend v2.0.10

Hivemind Platform App Backend

Endpoint documentation and additional information can be found in the wiki.

Quickstart

git clone git@github.com:HivemindAG/app-backend.git
cd app-backend
npm install
npm start -- --key <your-api-key>
# API is now available at http://localhost:8080

Caching

The app backend caches most requests to improve response time and reduce the load on the Hivemind Platform API.

Changes made to any entities might not be visible for up to 4 minutes (e.g. changing a device name or adding a new device). For long entity lists only the first 1000 entries will be returned.

Only the most recent 4000 samples can be accessed for every topic. New samples are pushed by the platform and will be available immediately.

Command Line Options

• --key
  • Hivemind Platform API key
• --port
  • Server port; default: 8080
• --config
  • App configuration object (JSON)

Environment Variables

• $PORT
  • Server port; default: 8080
• $CONFIG
  • App configuration object (JSON)
  • Use key-paths to overwrite single values within objects (e.g. {"platform.concurrentRequests": 4})
• $DEBUG
  • Sets the debug configuration property
  • Casted to a boolean, so any other value except true is considered false
  • Default: false

App Configuration Object Properties

• debug
  • More verbose console output (Boolean)
  • Default: false
• apiKey
  • Hivemind Platform API key (String)
• platform.apiURL
  • Hivemind Platform API URL (String)
  • Default: "https://api.hivemind.ch"
• platform.entityCacheTimeout
  • Cache entities for… ms
  • Default: 240000 (4 minutes)
• platform.concurrentRequests
  • Limit the number of concurrent Platform API requests
  • 0 for unlimited
  • Default: 8