Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.73 KB

HOSTING.md

File metadata and controls

41 lines (30 loc) · 1.73 KB

Hosting

Keycloak

The PDC API requires a Keycloak instance to handle authentication.

We suggest creating a second realm named pdc to separate Keycloak administrator accounts from PDC accounts.

service

The PDC API is a fairly standard Node.js application. It needs no special operating system permissions, and should be run as a non-root user.

Add the environment variables in .env.example however your hosting environment needs.

Be sure to set NODE_ENV=production, as recommended by the Node.js documentation and the Express documentation.

DigitalOcean App Platform

The PDC API can be deployed on DigitalOcean App Platform:

Deploy to DO

Although specified in the template, the API cannot be used with a DigitalOcean dev database, because dev databases do not allow schema creation and the PDC requires PostgreSQL schemas; the migrate job will fail with a permission denied error. Either delete the dev database and add a prod database with the same name during app creation, upgrade the generated dev database to a managed database after creating the app, or delete the dev database and configure the environment variables with credentials for a database hosted elsewhere.