Console Mount
The Console can be served under any arbitrary path on your server
console.mount
: Path on the server where the Console will be served
OAuth Options
The Console app uses the OAuth 2.0 authorization flow to authorize actions in the backend. You can customize the authorization parameters if necessary:
console.oauth.authorize-url
: The OAuth Authorize URLconsole.oauth.client-id
: The OAuth client IDconsole.oauth.client-secret
: The OAuth client secretconsole.oauth.token-url
: The OAuth Token Exchange URLconsole.oauth.logout-url
: The logout URL of the OAuth server used to perform client initiated logouts
Frontend Setup
You can change various values that will be passed to the JavaScript logic and HTML Head tags of the Web UI:
Component Configuration
The Console needs to know how the individual The Things Stack components are configured, so it can execute API calls correctly. Likewise, disabled components will cause possible respective options and menus in the Console frontend to be disabled.
console.ui.as.base-url
: Base URL to the HTTP APIconsole.ui.as.enabled
: Enable Application Server related functionality in the Consoleconsole.ui.gs.base-url
: Base URL to the HTTP APIconsole.ui.gs.enabled
: Enable Gateway Server related functionality in the Consoleconsole.ui.edtc.base-url
: Base URL to the HTTP APIconsole.ui.edtc.enabled
: Enable End Device Template Converter related functionality in the Consoleconsole.ui.is.base-url
: Base URL to the HTTP APIconsole.ui.is.enabled
: Enable Identity Server related functionality in the Consoleconsole.ui.js.base-url
: Base URL to the HTTP APIconsole.ui.js.enabled
: Enable Join Server related functionality in the Consoleconsole.ui.ns.base-url
: Base URL to the HTTP APIconsole.ui.ns.enabled
: Enable Network Server related functionality in the Consoleconsole.ui.qrg.base-url
: Base URL to the HTTP APIconsole.ui.qrg.enabled
: Enable QR Code Generator related functionality in the Consoleconsole.ui.gcs.base-url
: Base URL to the HTTP APIconsole.ui.gcs.enabled
: Enable Gateway Configuration Server related functionality in the Console
File Includes
You can control which CSS and JavaScript files are included into the rendered HTML of the Console. Note that these files must be present in the /public
folder during runtime.
console.ui.js-file
: The names of the JavaScript fileconsole.ui.css-file
: The names of the CSS files
Assets and Custom Branding
You can control the url of the assets folder that the Console frontend will use, e.g. if you plan on using a CDN to serve your assets. The branding base url will enable custom branding for logos, favicons and OpenGraph images. See the custom branding guide for detailed descriptions on this subject.
console.ui.assets-base-url
: The base URL to the page assetsconsole.ui.branding-base-url
: The base URL to the branding assetsconsole.ui.branding-cluster-id
: The cluster ID to show below the logoconsole.ui.branding-text
: The branding text to show below the logoconsole.ui.icon-prefix
: The prefix to put before the page icons (favicon.ico, touch-icon.png, og-image.png)console.ui.canonical-url
: The page canonical URLconsole.ui.descriptions
: The page descriptionconsole.ui.language
: The page languageconsole.ui.site-name
: The site nameconsole.ui.sub-title
: The page sub-titleconsole.ui.support-link
: The URI that the support button will point toconsole.ui.documentation-base-url
: The base URL for generating documentation linksconsole.ui.theme-color
: The page theme colorconsole.ui.title
: The page title