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

Files

D. Berge 8ec479805a Add version reporting library.

This reports the current server version, from Git by
default.

Also, and of more interest, it reports whether the
current database schema is compatible with the
server code.

2022-02-06 22:48:20 +01:00

api

Enfore info key access restrictions on the API.

2022-02-06 22:40:53 +01:00

events

Fix event detection failure.

2021-05-24 18:30:53 +02:00

lib

Add version reporting library.

2022-02-06 22:48:20 +01:00

queues/asaqc

Send Ocp-Apim-Subscription-Key with ASAQC requests

2021-10-04 21:00:41 +02:00

spec

Describe ASAQC-related API endpoints

2021-10-04 02:21:00 +02:00

udp

Remove logging statement

2020-09-13 17:30:25 +02:00

Make websocket notifications await.

2021-05-24 15:52:29 +02:00

index.js

Run events manager in a separate process.

2020-10-02 01:34:49 +02:00

package-lock.json

Implement sequence/get API endpoint.

2021-09-11 12:19:06 +02:00

package.json

Add CSV planner output option

2021-06-19 19:04:05 +02:00

README.md

Add API documentation

2020-10-23 11:09:08 +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.

Use

The API specification may be found under ./spec.

Generate the documentation with:

./node_modules/.bin/redoc-cli bundle ./spec/openapi.yaml