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
6b216f740654e118771757d14e75ed21a97423bd
dougal-software/lib/www/server
History
D. Berge 6b216f7406 Add library function to retrieve vessel information. 
In the `keystore` table, we now store information for our own
vessel (usually, where the Dougal server is installed). This
is an access function to retrieve that information.

The info stored for the vessel looks like this:

```yaml
type: vessel
key: ego
data:
    imo: 9631890
    mmsi: 257419000
    name: Havila Charisma
    contacts:
        -
            name: HC OM
            phone: tel:+47123456789
            email: hc.om@magseisfairfield.com
    organisations:
        Havila Charisma:
            read: true
            write: true
            edit: true
```
2025-07-12 16:42:28 +02:00
..
api
Remove dead code
2025-07-12 12:14:12 +02:00
events
Refresh organisations cache on project update
2025-07-11 22:48:06 +02:00
lib
Add library function to retrieve vessel information.
2025-07-12 16:42:28 +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
ws
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
Upgrade minimum required database version
2025-07-11 22:46:47 +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