Skip to content

Backend v4

The SciCat backend v4 is a rewrite of the original backend, built on top of the NestJS framework.

Configuration options

The backend-next service is mainly configured via environment variables. For an extensive list of available options see here .

Functional Accounts

There are a few functional accounts available for handling data:

Username Password Usage
admin 2jf70TPNZsS Admin
ingestor aman Ingest datasets
archiveManager aman Manage archiving of datasets
proposalIngestor aman Ingest proposals

Default configuration

In the default configuration folder config , the backend is set to use the mongo container .

Enable additional features

Additionally, by setting the env variable ELASTIC_ENABLED , the elastic search service is started and the backend is configured to connect to them.

If LDAP_ENABLED is toggled, you can use LDAP to log in with a LDAP user .

If OIDC_ENABLED is toggled, you can use OIDC to log in with a OIDC user .

With DEV=true , since the container might have limited memory, it is recommended to run unit tests with the option --runInBand , as here , which makes the tests run sequentially, avoiding to fill the RAM which makes them freeze.

Dependencies

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

graph TD
    elasticsearch --> backend