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
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
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
isTemplateGeneratedByOspComposer	If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.
	type	boolean
moduleId	The id of the module who need this cfg. At least [keycloak, web and dispatcher] need it.
	type	array
	items	type	string
hostname	Defines the hostname used to expose the stack
	type	string
	default	stack-1.onsphere.local
frontendPort	Defines the front-end port used to expose the stack
	type	integer
	maximum	65535
	minimum	1
	default	5000
frontendSchema	Defines the front-end schema used to expose the stack
	type	string
	pattern	(https?)?
	default	https
name	Defines the stack name
	type	string
	default	OnSphere
description
integrator	Defines the stack integrator
	default	company	Swissdotnet SA
		email	info@swissdotnet.ch
		phone	+41 (0)26 510 29 30
	Integrator
theme	Defines visual element for the theme
	default	mode	dark
		modeIsLocked	False
		logoWithoutText
		logoWithText
		background
		favicon
		disableHelpLink	False
	Theme
markdownDescription
additionalProperties	False

Integrator

type	object
properties
company	Defines the company integrating the stack
	type	string
	default	Swissdotnet SA
email	Defines the email of the company integrating the stack
	type	string
	default	info@swissdotnet.ch
phone	Defines the phone number of the company integrating the stack
	type	string
	default	+41 (0)26 510 29 30
additionalProperties	False

Theme

type	object
properties
mode	Defines front-end theme. Whether light or dark (default).
	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.
	type	boolean
	default	False
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
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
background	The background image for the login page. The file must be added on the resources of the module keycloak.
	type	string
favicon	The favicon image. The file must be added on the resources of the module keycloak and web.
	type	string
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.
disableHelpLink	Disable help link in front-end
	type	boolean
	default	False
additionalProperties	False