mirror of https://gitlab.com/wgp/dougal/software.git synced 2025-12-06 10:27:09 +00:00

Files

D. Berge a73376572b API: Add label querying endpoint.

Labels can be associated with events and can have
display properties such as a description and colour,
this is why we need an endpoint for the client to
retrieve them.

2020-08-12 11:41:28 +02:00

api

API: Add label querying endpoint.

2020-08-12 11:41:28 +02:00

lib

API: Add label querying endpoint.

2020-08-12 11:41:28 +02:00

index.js

Initial commit

2020-08-08 23:59:13 +02:00

package-lock.json

Initial commit

2020-08-08 23:59:13 +02:00

package.json

Initial commit

2020-08-08 23:59:13 +02:00

README.md

Initial commit

2020-08-08 23:59:13 +02:00

README.md

Dougal web server

Backend server for the user interface

Install

Clone / copy this directory to the destination directory and then run

npm install

Run

In production this should be run as a system service, but for development or a one-off run:

node index.js

npm start

Options

The following environment variables affect the behaviour of the application:

NODE_ENV: If NODE_ENV=test some output messages are suppressed.
HTTP_PORT: Port to listen on. Default is 3000.
HTTP_PATH: Path to prepend to the API routes. Default is null.
DOUGAL_API_CONFIG: Location of the API configuration file. Default is $HOME/etc/www/config.json.

The server always listens on 127.0.0.1. Use a proxy like Nginx to expose it to the network.