Aaltronav/dougal-software
1
0
Fork 0
mirror of https://gitlab.com/wgp/dougal/software.git synced 2025-12-06 10:27:09 +00:00
Code Issues Packages Projects Releases Activity
Files
3c4a558e02a722e5f29637ce956b5478197088cd
dougal-software/lib/www/server
History
D. Berge 3c4a558e02 Serve OpenAPI document on API root. 
When a client makes a request for `/` (the root of
the API), the OpenAPI description is served in an
appropriate format according to the `Accept` request
header, as follows:

Accept: text/html => HTML version
Accept: application/json => JSON version
Accept: * => YAML version
2020-12-29 16:20:57 +01:00
..
api
Serve OpenAPI document on API root.
2020-12-29 16:20:57 +01:00
events
Run events manager in a separate process.
2020-10-02 01:34:49 +02:00
lib
Merge branch '61-user-authentication' into devel
2020-10-23 15:14:09 +02:00
spec
Document login and logout endpoints
2020-10-23 17:28:41 +02:00
udp
Remove logging statement
2020-09-13 17:30:25 +02:00
ws
Listen for planner events
2020-10-09 13:55:34 +02:00
index.js
Run events manager in a separate process.
2020-10-02 01:34:49 +02:00
package-lock.json
Merge branch '61-user-authentication' into devel
2020-10-23 15:14:09 +02:00
package.json
Create HTML version of OpenAPI doc on install.
2020-12-29 16:18:53 +01: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