chhaang

Chhaang is the integration interface of the videobase project. It currently hosts an Aptoma DrPublish plugin for embedding videos.

Developing

On pre-push, typescript will compile the typescript-files.

running chhaang

node chhaang --config <config.json>

configuration

• kvass (required) - the location of the kvass server
• port (required) - the port that chhaang should run on
• stoutmeal (required) - either a relative path to the stoutmeal config file or a stoutmeal config object. see the stoutmeal docs for more info
• DrPublish (optional) - a DrPublish plugin config object. if omitted, a DrPublish plugin will not be provided.
• (deprecated) Feide (optional) - a Feide SAML endpoint config object. If omitted, no Feide SAML endpoint will be available.
• OpenIDEnabled (optional) - Specify if OpenID is enabled

• OpenIDProviders(optional) - Specify a list of Open ID providers. If omitted, no Open ID endpoints will be available.

DrPublish configuration

• width (optional, default 600) - default width of embedded videos
• height (optional, default 338) - default height of embedded videos
• background (optional, default #000) - background color of embedded videos

Feide configuration (deprecated)

• saml - SAML metadata config object
• accessRequirement (optional, default none) - user metadata requirements for access

Open ID configuration

An array with the following values. Must be combined with OpenIDEnabled

• clientId - The client ID
• clientSecret - The client secret
• discoveryURL - The Open ID discovery URL
• type - The type of open id provider. Currently supported types are microsoftand feide Example:

{
  ...
  "OpenIDProviders": [{
      "type": "microsoft", // allowed value: microsoft | feide
      "clientId": "<client-id>",
      "clientSecret": "<client-secret>",
      "discoveryURL": "<discovery-url>"
    }
  ]
}

saml (deprecated)

• entryPoint - Single Sign On URL. Example: "https://openidp.feide.no/simplesaml/saml2/idp/SSOService.php"
• logoutUrl - Single Sing Out URL. Example: "https://openidp.feide.no/simplesaml/saml2/idp/SingleLogoutService.php"
• issuer - The identity of this BRIK instance when registered as a service provider. Example: "brik-dummy-sp"

accessRequirement

Object which keys are user metadata fields, and values are rule objects for those fields.

If a user's metadata does not match all rules, access will be rejected.

Rule object format:

• type (optional, default string) - How to interpret the metadata field's value. Can be list or string.
• value - Requirement on the user metadata field. If string, must have this value. If list, the value must be found in one of the list items.