Link Search Menu Expand Document

Deployment

The Ontology Manager is typically deployed using Docker.

Run an editor container with the following environment variables:

# customer namespace
## this should be a slug, so no space, no special characters etc
CUSTOMER_NAME=zazuko

# postgres config
POSTGRESQL_USER=postgres
POSTGRESQL_PASSWORD=make-this-secret
POSTGRESQL_DATABASE=postgres
POSTGRESQL_HOST=localhost

# secret seed for JWT - https://www.graphile.org/postgraphile/security/
POSTGRAPHILE_TOKEN_SECRET=this-is-secret-as-well

OAUTH_HOST=https://github.com/login/oauth
OAUTH_CLIENT_ID=
OAUTH_CLIENT_SECRET=
GITHUB_PERSONAL_ACCESS_TOKEN=

# optional variables
DEBUG=editor:*
# SENTRY_DSN=

Without further customization, the default theme will be used. You can set the theme used by the Ontology Manager at runtime using the following environment variable: EDITOR_THEME=zazuko. Valid values for EDITOR_THEME are any folder name in ./assets/themes/ that have a theme.scss in it.

Prod Deployment

Two containers: Postgres (probably already running to host other customers’ editors) and the editor container.

The editor container needs the following env vars:

# customer name is a slug, schema-alod-ch, zazuko, dcf-org, …
CUSTOMER_NAME=zazuko
# This password needs to match the one set on the postgres container
POSTGRESQL_PASSWORD=make-this-secret
# `containername` if postgres is linked with the name `containername`
POSTGRESQL_HOST=db
# a token used as hash/salt, keep it secret for JWT security
POSTGRAPHILE_TOKEN_SECRET=this-is-secret-as-well

That’s it. The remaining configuration is done using the installer (navigate to the container’s /zom/install once it’s up).

healthcheck endpoint

GET /api/health should return HTTP200 with content ok as plain text.