Skip to main content

Minimum Helm configuration

The following three configurations are required to be available before you can deploy the helm chart. These are provided by your cloud provider or as services within your cluster.

  • PostgreSQL database
  • OIDC provider
  • Blob store

We use the term store to group configuration for any service that stores data for the QuickCase app. Thus databases and attachments are accessed via .Values.store

PostgreSQL database

Two databases are required, one for the cases and one for the case definitions.

warning

Only PostgreSQL is supported

note

You can use a single database by using PostgreSQL schemas

store:
  cases:
    db_name: cases
    host: some-host.com
    port: 5432
    password: ''
    username: quickcase
    options: {}
  definitions:
    db_name: cases
    host: some-host.com
    port: 5432
    password: ''
    username: quickcase
    options: {}

OIDC provider

oidc:
  jwksUrl: https://cognito-idp.eu-west-2.amazonaws.com/eu-west-2_NNNNNNN/.well-known/jwks.json
  loginUrl: https://quickcase-nonprod.auth.eu-west-2.amazoncognito.com/login
  loginUrlParams: {}
  logoutUrl: https://quickcase-nonprod.auth.eu-west-2.amazoncognito.com/logout
  logoutUrlParams: {}
  tokenUrl: https://quickcase-nonprod.auth.eu-west-2.amazoncognito.com/oauth2/token
  userInfoUrl: https://quickcase-nonprod.auth.eu-west-2.amazoncognito.com/oauth2/userInfo
  openidScope: openid
  claims:
    # These are the default claim names, see https://github.com/quickcase/spring-oidc#configuration
    prefix: ''
    sub: sub
    name: name
    email: email
    roles: app.quickcase.claims/roles
    organisations: app.quickcase.claims/organisations
    defaultJurisdiction: app.quickcase.claims/default_jurisdiction
    defaultCaseType: app.quickcase.claims/default_case_type
    defaultState: app.quickcase.claims/default_state

Attachments store

note

Attachment store is optional, but is enabled by default.

To disable:

attachment_store:
  enabled: false

Attachments are stored securely, with access controlled by QuickCase. Users authorised to access a case are provided with temporary authorised URLs which provides direct access to the store to upload or download attachments.

warning

We only support the following cloud providers:

  • AWS S3
  • Azure blob storage, and
  • Google storage.
attachments:
   #provider: amazon-s3  # azure-blob, google-storage
   amazon-s3:
     bucket: attachment-store-s3-bucket
     region: eu-west-2
   #azure-blob:
   #  storageAccountName:
   #  storageAccountKey:
   #  container:
   #google-storage:
   #  bucket: