Aaltronav/dougal-software
1
0
Fork 0
mirror of https://gitlab.com/wgp/dougal/software.git synced 2025-12-06 12:17:08 +00:00
Code Issues Packages Projects Releases Activity
Files
2cc293b7245836004bbde033a833075c2063714b
dougal-software/lib/www/server
History
D. Berge 707889be42 Refactor layer API endpoint and database functions. 
- A single get() function is used both to list all available
  layers, if no layer name is given, or a single layer.
- The database no longer holds the actual layer contents,
  only the path to the layer file(s), so the list() function
  is now redundant as we return the full payload in every case.
- The /gis/layer and /gis/layer/:name endpoints now have the same
  payload structure.
2023-09-12 19:29:02 +02:00
..
api
Refactor layer API endpoint and database functions.
2023-09-12 19:29:02 +02:00
events
Add event handler for midnight shot detection.
2022-05-15 14:06:18 +02:00
lib
Refactor layer API endpoint and database functions.
2023-09-12 19:29:02 +02:00
queues/asaqc
Send Ocp-Apim-Subscription-Key with ASAQC requests
2021-10-04 21:00:41 +02:00
spec
Update API description
2022-05-04 18:13:14 +02:00
udp
Replace console output by debug functions
2022-05-15 13:38:47 +02:00
ws
Clean up whitespace.
2022-04-29 14:48:21 +02:00
debug.js
Migrate more console messages to debug()
2022-05-12 22:09:08 +02:00
index.js
Default the API prefix to /api
2023-05-18 18:34:10 +02:00
package-lock.json
Breaking-change Node package udpates (server)
2023-09-10 11:49:56 +02:00
package.json
Breaking-change Node package udpates (server)
2023-09-10 11:49:56 +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