Customization

A Helion Stackato deployment can be extensively customized and themed. Administrators can add or remove runtimes, frameworks and services from the system, and change the look and content of the Management Console interface.

Console Settings

The Management Console is modified mainly through the Settings > Console pages. Settings are saved as variables which can subsequently be used in HTML pages via the Embedded JavaScript (EJS) templating engine.

Product

  • Product Name: Overrides all occurrences of 'Helion Stackato'
  • Company Name: Overrides all occurrences of 'HPE'
  • Vendor Version: Overrides all occurrences of the Helion Stackato version number.
  • Default Locale: Sets the default locale of the console if the users current locale is not recognized. Currently, only the 'en' localization is complete.
  • External Docs URL: The link to direct users to to view docs. Defaults to the current documentation published to docs.stackato.com. Ticking 'Use local docs' will cause this URL to be ignored and the docs from the VM will be served instead.

Client

The Helion Stackato CLI client version number and the paths or URLs to the downloadable archives for each platform.

Local paths are relative to the /home/stackato/stackato/ directory (Router node, see Renaming the Client), but HTTP URLs can also be used for externally hosted files.

The client executables served from the VM are the latest version available at the time of the Helion Stackato VM release, but updated clients may become available between releases. The current release of the Helion Stackato CLI client is always available for download.

Look and Feel

  • FavIcon Logo URL: The favicon to use. Recommended to be 32x32px image/png.
  • Header Logo URL: The logo image to use in the header. Size can vary although anything bigger than 50px vertically may result in some distortion of the header (fixable with a custom style sheet).
  • Footer Logo URL: The logo image to use in the footer. Same as above but height is about 40px before distortion occurs.
  • Background Color: Sets the background color of the console.

Welcome Page

The HTML/EJS to show on the Welcome page. The settings variables and username variable (current user) are available via EJS, but plain HTML will work for simple use cases.

Support Page

The HTML/EJS to show on the Support page. The settings variables and support_email variable (see Settings > Controller) are available.

Eula Content

The HTML/EJS to show in the EULA overlay. The settings variables are available.

Custom Stylesheet

CSS defined here will be applied to the page after the default CSS has been loaded, and override and replace any style. Use this to change the layout and color of any element in the Management Console. Use web development tools like Firebug or Chrome DevTools to inspect elements and find the relevant styles.

Settings Variables

The following variables (with their default values) are available in the EJS templates on the settings object (for example, settings.product_name):

  • product_name: null,
  • company_name: 'Hewlett Packard Enterprise',
  • vendor_version: '3.0',
  • default_locale: 'en',
  • product_logo_favicon_url: 'img/stackato_logo_favicon.png',
  • product_logo_header_url: 'img/stackato_logo_header.png',
  • product_logo_footer_url: 'img/stackato_logo_footer.png',
  • background_color: '#ffffff',
  • style: '',
  • support_template: SupportTemplate,
  • eula_template: EulaTemplate,
  • welcome_template: WelcomeTemplate,
  • external_docs_url: 'http://docs.stackato.com/3.0/',
  • use_local_docs: "false"

Restoring values

You can click Load Default for each individual setting (refresh icon to the left of the value field) which will replace the customized value with the default for that setting. To apply the changes, click Save.

Clicking Load Defaults (in red) at the top of the page deletes all customizations and loads defaults for all settings.

As a failsafe for when style changes have obscured the interface, admins can also reset specific settings by loading a URL in the following format:

https://<stackato-url>/#settings/console/reset/setting_name

Replace setting_name with one of the variables above and that value will be reset to the default.

Error Pages

To expose customized error pages, create the following HTML files in /home/stackato/stackato/static/vendor/errors/ on each Router node:

  • 404.html
  • 422.html
  • 500.html
  • 502.html
  • app-not-available.html

When present, these files will be used to display the corresponding HTTP errors.

The default error page files in /home/stackato/stackato/code/console/errors/ can be used as a reference, but should not be modified directly as changes may be lost during upgrades or patches.

OEM Branding

The modifications displayed above are made on Helion Stackato VM instances that have already run through first-boot configuration.

Helion Stackato OEM customers can brand and customize the Helion Stackato VM for deployment or distribution as described in the OEM Customization section.