stack.cfg

Shared stack

You can provide several stack information (some required) and some informational. The file can be anywhere in the root folder with name stack.cfg. Only one stack.cfg can be present in the hierarchy. The theme resources must be add as resource on at least [keycloak].

type	object
properties
description	Defines the stack description
	type	string
	default
enableAuditLog	Enable audit log system. Enable this option will start generating logs about all users interactions. Make sure to add all modules that are logged into the list moduleId. Learn more about Audit logging ↗️. Default value is [false]
	type	boolean
	default	False
frontendPort	Defines the front-end port used to expose the stack Default value is [5000]
	type	integer
	maximum	65535
	minimum	1
	default	5000
frontendSchema	Defines the front-end schema used to expose the stack Default value is [“https”]
	type	string
	pattern	https?
	default	https
hostname	Defines the hostname used to expose the stack Default value is [“stack-1.onsphere.local”]
	type	string
	default	stack-1.onsphere.local
integrator	Defines the stack integrator Default value is [{“company”:”SDN SA”,”email”:”info@sdn.ch”,”phone”:”+41 (0)26 510 29 30”}]
	default	company	SDN SA
		email	info@sdn.ch
		phone	+41 (0)26 510 29 30
	Integrator
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
moduleId	The id of the module who need this cfg. At least [keycloak, web and dispatcher] need it.
	type	array
	items	type	string
name	Defines the stack name Default value is [“OnSphere”]
	type	string
	default	OnSphere
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
theme	Defines visual element for the theme Default value is [{“background”:””,”disableDashboardEdit”:false,”disableHelpLink”:false,”favicon”:””,”language”:{“authorizedLanguages”:[“en”,”fr”,”de”]},”logoWithText”:””,”logoWithoutText”:””,”mode”:”dark”,”modeIsLocked”:false}]
	default	background
		disableDashboardEdit	False
		disableHelpLink	False
		favicon
		language	authorizedLanguages	en
				fr
				de
		logoWithText
		logoWithoutText
		mode	dark
		modeIsLocked	False
	Theme
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
additionalProperties	False

Integrator

type	object
properties
company	Defines the company integrating the stack Default value is [“SDN SA”]
	type	string
	default	SDN SA
email	Defines the email of the company integrating the stack Default value is [”info@sdn.ch”]
	type	string
	default	info@sdn.ch
phone	Defines the phone number of the company integrating the stack Default value is [“+41 (0)26 510 29 30”]
	type	string
	default	+41 (0)26 510 29 30
additionalProperties	False

Theme

type	object
properties
background	The background image for the login page. The file must be added on the resources of the module keycloak.
	type	string
disableDashboardEdit	Disable edition of the dashboard Default value is [false]
	type	boolean
	default	False
disableHelpLink	Disable help link in front-end Default value is [false]
	type	boolean
	default	False
experimentalThemeOverride	Experimental MUI theme, the format must be as follows: {“dark”: {…}, “light”: {…}, “all”: {…}}. All data allow to specify standard value that are defined for all integrations. Dark and lights depends on user/integration theme. Note: This feature is experimental and will probably change. This is an attempt at adding integrator control over themes and MUI styling.
favicon	The favicon image. The file must be added on the resources of the module keycloak and web.
	type	string
language	Configure the available languages for the stack Default value is [{“authorizedLanguages”:[“en”,”fr”,”de”]}]
	default	authorizedLanguages	en
			fr
			de
	LanguageSettings
logoWithText	The logo to display on the account page. If it is not define, the logo without text will be used or the default one. The file must be added on the resources of the module keycloak and web.
	type	string
logoWithoutText	The logo to display on the login page, account page and the dashboard. If it is not define, the logo with text will be used or the default one. The file must be added on the resources of the module keycloak and web.
	type	string
mode	Defines front-end theme. Whether light or dark (default). Default value is [“dark”]
	type	string
	enum	light, dark
	default	dark
modeIsLocked	If set to true, the user can’t modify the current theme on the front end using the icon in the toolbar. Default value is [false]
	type	boolean
	default	False
additionalProperties	False

LanguageSettings

type	object
properties
authorizedLanguages	Defines the stack authorized languages. Available languages are english (en), french (fr) and german (de). Default language must be a part of this. Currently, this only impact the front-end. Default value is [[“en”,”fr”,”de”]]
	type	array
	default	en
		fr
		de
	items	type	string
		enum	en, fr, de
defaultLanguage	Defines the stack default locale. Available languages are english (en), french (fr) and german (de). Currently, this only impact the front-end.
	type	string
	enum	en, fr, de
additionalProperties	False