Aaltronav/dougal-software
1
0
Fork 0
mirror of https://gitlab.com/wgp/dougal/software.git synced 2025-12-06 08:47:07 +00:00
Code Issues Packages Projects Releases Activity
Files
051049581a97797fe202a283fe65ccf9444b361e
dougal-software/lib/www/server
History
D. Berge 051049581a Merge branch '278-rewrite-events-queue' into 'devel' 
Resolve "Rewrite events queue"

Closes #278

See merge request wgp/dougal/software!46
2023-10-17 10:28:21 +00:00
..
api
Add events change API endpoint
2023-10-17 11:15:36 +02:00
events
Rewrite events listener and handlers.
2023-10-14 20:53:42 +02:00
lib
Merge branch '278-rewrite-events-queue' into 'devel'
2023-10-17 10:28:21 +00:00
periodic-tasks
Run some tasks periodically from the main process.
2023-10-14 20:06:38 +02:00
queues/asaqc
Send Ocp-Apim-Subscription-Key with ASAQC requests
2021-10-04 21:00:41 +02:00
spec
Add event changes API endpoint description
2023-10-17 12:15:41 +02:00
udp
Replace console.log() with debug library calls
2023-10-14 19:57:57 +02:00
ws
Remove ad-hoc notifier
2023-09-29 15:59:12 +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 CSV output option for events log
2023-09-13 21:58:06 +02:00
package.json
Update required database version
2023-09-15 14:22:22 +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

or

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