DGRSC (Document Generation Service Showcase) Backend is a simple node.js wrapper around the BC Gov. Common Document Generation Service. The wrapper is a simple pass through to the CDOGS service, its main purpose is to hide the service client credentials from the frontend. We host the showcase frontend from this node.js backend.
The DGRSC Backend will require some configuration, namely credentials to CDOGS and where to call CDOGS. We also want to lock down our api using a JWT Token for DGRSC. We will need to configure our DGRSC backend to authenticate using the same KeyCloak realm and client that the frontend uses. All configuration for the frontend will come from the DGRSC backend, fetched by calling a configuration url (/config).
We are using the npm library: config, to configure our application. We can either set environment variables to be picked up by custom-environment-variables.json or we can create a local configuration file (do not check into source control) such as local.json. Please read the config library documentation to see how it overlays various environment files and uses environment variables to override those values (when provided).
FRONTEND_APIPATH has no beginning '/', that is so it will always call the relative api.
| Name | Default | Description |
|---|---|---|
| FRONTEND_KC_CLIENTID | The name of the frontend authorization service client - Users login to this (KeyCloak) client to get authenticated and authorized to DGRSC. | |
| FRONTEND_KC_REALM | The KeyCloak realm id | |
| FRONTEND_KC_SERVERURL | The KeyCloak authorization url | |
| FRONTEND_APIPATH | api/v2 | Relative path for frontend to call backend api |
| CDOGS_CLIENT_ID | The name of the service client in the realm that has been granted access to CDOGS. | |
| CDOGS_CLIENT_SECRET | The service client's password | |
| CDOGS_TOKEN_URL | The OpenID token url to authenticate this client | |
| CDOGS_API_URL | The CDOGS url | |
| SERVER_APIPATH | /api/v2 | |
| SERVER_BODYLIMIT | 30mb | Set the allowed request body size (will include encoded attachments). See body-parser limit and bytes lib |
| SERVER_HOSTURL | http://localhost:8080 | The domain/base url where we will expose the api. |
| SERVER_LOGLEVEL | info | set the npm log level (verbose, debug, info, warn, error). |
| SERVER_PORT | 8080 | port for node to listen on. |
| SERVER_KC_CLIENTID | The name of the backend authorization service client | |
| SERVER_KC_CLIENTSECRET | The KeyCloak service client's password | |
| SERVER_KC_REALM | The KeyCloak realm id | |
| SERVER_KC_SERVERURL | The KeyCloak authorization url |
npm run all:fresh-start
npm run all:test
npm run all:lint
npm run all:lint-fix