Skip to content
Katalogue Docs

Deployment Overview

Katalogue is a self-hosted application and has been deployed in production scenarios in Azure and in Redhat OpenShift. This page is a high-level blueprint and deployment checklist, there will probably be many organization-specific details to adhere to from case to case.

See more detailed examples for the following deployment scenarios:

Minimum Configuration

Section titled “Minimum Configuration”

This section covers the minimum config parameters required to get the Katalogue spa and api services to start properly. You might have to set others for your specific deployment.

See the Configuration Overview on how to set the config parameters and Config Parameter Reference for a description and complete list of all available parameters.

Backend Service (api)

Section titled “Backend Service (api)”

These are the minimum parameters that need attention for the api backend service to start:

  • API_ENDPOINT_BASE_URL - Full URL of the backend API app, e.g. https://katalogue-demo-api.azurewebsites.net. This is used to verify the access- and refresh tokens to authenticate users.
  • PORT - Port the backend api is served on. Defaults to 8888.
  • COOKIE_SAME_SITE - Set to string None if backend API app and frontend app are hosted on different servers. Otherwise boolean true.
  • COOKIE_SECURE - Set to boolean true if backend API app and frontend app are hosted on different servers. Otherwise boolean false.
  • CORS_ORIGIN - Array with URLs that are allowed to send requests to the API. Must at least containt the frontend app URL, e.g. https://katalogue-demo.azurewebsites.net
  • ENCRYPTION_KEY secret - Should be a long, random string that you keep safe. This is used to hash and encrypt passwords (local user account passwords and datasource connection passwords) in the Katalogue repository database. Currently, Katalogue does not support key rotation, meaning that this cannot be changed later if you already have encrypted data in the repository database
  • REPOSITORY_HOSTNAME - Hostname of the Katalogue PostgreSQL repository database.
  • REPOSITORY_PORT - Port of the Katalogue PostgreSQL repository database.
  • REPOSITORY_USERNAME - Username to connect to the Katalogue PostgreSQL repository database.
  • REPOSITORY_PASSWORD secret - Password for the username to connect to the Katalogue PostgreSQL repository database.
  • REPOSITORY_USE_SSL - Set to boolean true if the PostgreSQL database is configured to only accept encrypted connections, otherwise boolean false.
  • TRUST_PROXY (only required when the api is behind a reverse proxy or load balancer; see Network Proxy Configuration)

Frontend Service (spa)

Section titled “Frontend Service (spa)”

These are the minimum parameters that need attention for the spa frontend service to start:

Deployment Checklist

Section titled “Deployment Checklist”

Here is a checklist with the most common tasks that need to be completed in order to deploy Katalogue in a production scenario.

Prerequisities and Requirements

Section titled “Prerequisities and Requirements”

System requirements…

Networking

Section titled “Networking”

TODO

User Accounts & Permissions

Section titled “User Accounts & Permissions”

TODO

CI/CD

Section titled “CI/CD”

TODO

Database Backup & Restore

Section titled “Database Backup & Restore”

TODO

Documentation

Section titled “Documentation”

TODO

Deployment Protocol…