Skip to content

Backend

The SciCat backend HTTP service.

Configuration options

For a list of configuration options, please look at v3 or v4 options.

Default configuration

By default v4 is used.

Enable additional features

The BE_VERSION value controls which version of the backend should be started, either v3 or v4 (default).

Setting the BACKEND_HTTPS_URL and OIDC_ENABLED env variables requires changing the OIDC configuration, either in the v3 compose.oidc.yaml and providers.oidc.json , or the v4 env file .

Additionally, by setting the env variable JOBS_ENABLED , the rabbitmq service is started and the backend configured to connect to it.

Dependencies

Here below we show the internal dependencies of the service, which are not already covered in the root docs (if B depends on A , then we visualize it as A --> B ). The same subdomain to service convention applies.

⚠ When setting BACKEND_HTTPS_URL and OIDC_ENABLED , you might need to also set KEYCLOAK_HTTPS_URL to correctly resolve the login flow redirects. A more detailed explanation for v3 can be found here, and it is similar for v4.

graph TD
    mongodb --> backend
    ldap --> backend
    keycloak --> backend
    rabbitmq --> backend