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

Files

D. Berge 8bbe3aee70 Make planned line names configurable.

Line names are made up based on:

* Certain properties defined by the system
* Values assigned to those properties either by the system
  or by the user (line number, sequence, attempt, etc.)
* A line format specification configured by the user for each
  project (`online.line.lineNameBuilder.fields`)

Closes #129.

2025-07-09 16:30:26 +02:00

api

Stop attempt at sending a spurious 404.

2024-05-09 14:18:56 +02:00

events

Rewrite events listener and handlers.

2023-10-14 20:53:42 +02:00

lib

Make planned line names configurable.

2025-07-09 16:30:26 +02:00

periodic-tasks

Add refresh-project-summary periodic task.

2023-11-02 13:25:34 +01:00

queues/asaqc

Send Ocp-Apim-Subscription-Key with ASAQC requests

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

spec

Simplify versions handling

2023-11-02 23:47:13 +01:00

udp

Replace console.log() with debug library calls

2023-10-14 19:57:57 +02:00

Process JWT messages over WebSockets

2024-05-01 10:06:35 +02:00

debug.js

Migrate more console messages to debug()

2022-05-12 22:09:08 +02:00

index.js

Clean up on SIGINT, SIGHUP signals

2023-10-14 20:07:19 +02:00

package-lock.json

Add path-to-regexp depedency.

2023-11-04 10:45:50 +01:00

package.json

Update minimum required database schema to 0.5.0

2024-05-04 17:30:34 +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