Skip to main content

Configuration

The STS config.yaml contains different sections contain configuration information which can be modified accordingly by the users which are as follows:

config.yaml

# super admin section is for initial on-boarding and setup,
# if this section is empty the data will be either reset or fresh start.
superadmin:
email: sts.admin@megh.com
firstname: Sts
lastname: Admin
password: <password>
# STS has different submodules which has different responsibility and behaviour.
# The order of the submodules to initiate is relevant for dependency injection.
module:
# broker - [REQUIRED] central websocket broker for handling portal connection.
broker:
hash: default
# auth - [REQUIRED] oauth service with client credentials.
# client domain is the portal redirection url.
auth:
host: localhost
port: 80
client:
- name: default
id: <ClientID>
secret: <ClientSecret>
redirecturis:
- "http://localhost:8000/oauth2/callback"
responsetypes:
- "id_token"
- "code"
- "token"
granttypes:
- "client_credentials"
scopes:
- "admin"
- "openid"
- "photos"
- "offline"
- name: Portal
id: <ClientID>
secret: <ClientSecret>
allowedaudiences:
- "https//localhost"
- "http://localhost:3000"
redirecturis:
- "http://localhost/callback"
- "http://localhost:3000/callback"
- "http://localhost:9094/oauth2"
responsetypes:
- "id_token"
- "code"
- "token"
- "id_token token"
granttypes:
- "implicit"
- "refresh_token"
- "authorization_code"
- "password"
- "client_credentials"
scopes:
- "admin"
- "openid"
- "photos"
- "offline"
# api - [REQUIRED] APIs for STS + Nimble
api:
doc: true
host: 0.0.0.0
port: 8000
# cache - [REQUIRED] redis cache for alert-notification feature.
cache:
mode: memory
# nimble - [REQUIRED] this section points to nimble hosts for upstream analytics.
# metadataconnection - [REQUIRED] is connection type handler, ws - websocket / zmq - zmq tcp connection.
nimble:
metadataconnection: ws
hosts:
- sitekey: default
host: nimble:6344
# scheduler - [REQUIRED] scheduled events and alert conditions.
scheduler:
timezone: utc
# sms - sms notifications.
sms:
authkey: "************"
authtoken: "************"
provider: "twilio"
from: "+10000000000"
to: "+100000000000"
# smtp - [REQUIRED] mail notifications.
smtp:
auth: true
host: smtp
port: 2500
username: notification@megh.com
password: NimbleUser
from: notification@megh.com
to: test@megh.com
attachment: false
# storage - [REQUIRED] image/video storage module.
storage:
type: minio
# webhook - [REQUIRED] web hooks integrations
webhook:
base64attachment: true
# websocket - [REQUIRED] websocket connection handlers for portal.
websocket:
host: 0.0.0.0
port: 5000

superadmin:

super admin section contains information like email, first name, last name, password.

super admin section is for initial on-boarding and setup, if this section is empty the data will be either reset or fresh start.

module:

STS has different submodules which has different responsibility and behaviour. The order of the submodules to initiate is relevant for dependency injection.

broker:

This contains the central websocket broker for handling portal connection. This has hash set to default.

auth:

This section contains the oauth service with client credentials.This has the client domain which is the portal redirection url.

api:

This section contains the info of the APIs for STS + Nimble

cache:

This section contains info of redis cache for alert-notification feature.

nimble:

This section points to nimble hosts for upstream analytics. It also provides information on metadata connection i.e. with the connection type handler, ws - websocket / zmq - zmq tcp connection.

scheduler:

This section contains information of timezone for scheduled events and alert conditions.

sms:

This section contains information for configuring sms notifications.

smtp:

This section contains information for configuring mail notifications.

storage:

This section contains information of the image/video storage module. The type of storage server i.e minio.

webhook:

This section contains information for web hooks integrations.

websocket:

This section contains information of websocket connection handlers for portal.

clip:

This section contains information for email attachments as video clip if enabled.

proxy:

This section contains information of nimble mp4 proxy pub/sub.