Aaltronav/dougal-software
1
0
Fork 0
mirror of https://gitlab.com/wgp/dougal/software.git synced 2025-12-06 13:27:08 +00:00
Code Issues Packages Projects Releases Activity
Files
f623954399fad4b6485ff145658d2dbc700b1878
dougal-software/lib/www/server
History
D. Berge 808c9987af Add binary format middleware for sequence data. 
It responds to the MIME type:
application/dougal-map-sequence+octet-stream
2025-07-26 19:05:00 +02:00
..
api
Add binary format middleware for sequence data.
2025-07-26 19:05:00 +02:00
events
Refresh organisations cache on project update
2025-07-11 22:48:06 +02:00
lib
Add custom binary format packing / unpacking.
2025-07-26 19:05:00 +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
Update OpenAPI specification
2025-07-13 11:15:41 +02:00
udp
Replace console.log() with debug library calls
2023-10-14 19:57:57 +02:00
ws
Fix JWT renewal over websocket
2025-07-25 14:21:26 +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.json
Use @dougal/user, @dougal/organisations modules in backend
2025-07-24 18:27:59 +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