Skip to content
The Things Stack documentation home
Getting Started Concepts Cloud Enterprise Integrations API Hardware
Getting Started Concepts
Cloud Enterprise
Integrations API Hardware
Get The Things Stack

    Recent searches

      Popular pages

      • Getting Started
      • Adding Gateways
      • Adding Devices
      • Payload Formatters
      • Webhooks
      • Authentication

      No results for “”.

      • Check the spelling, or try fewer or more general words.
      • Ask the community on The Things Network Forum
      • Contact support
      ↑↓ to navigate ↵ to open Esc to close

      The Things Stack Enterprise

      • Overview
      • AWS
      • Kubernetes
      • Docker
      • The Things Join Server
      • Manage The Things Stack
        • Configuration
          • General Options
          • Tenant Billing Server Options
          • Alert Routing Server Options
          • Application Server Options
          • Command-Line Interface Options
          • Console Options
          • Device Claiming Server Options
          • Gateway Configuration Server Options
          • Gateway Server Options
          • Identity Server Options
          • Join Server Options
          • Network Operations Center Options
          • Network Server Options
          • Packet Broker Agent Options
        • Rate Limiting
        • Resource Limiting
        • Setting up billing with Stripe
        • Tenant Management

      Console Options

      Updated 13 February 2025 Edit on GitHub
      Copy page
      • View as MarkdownThis page as plain text
      • Open in ChatGPTAsk questions about this page
      • Open in ClaudeAsk questions about this page

      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 URL
      • console.oauth.client-id: The OAuth client ID
      • console.oauth.client-secret: The OAuth client secret
      • console.oauth.token-url: The OAuth Token Exchange URL
      • console.oauth.logout-url: The logout URL of the OAuth server used to perform client initiated logouts
      • console.oauth.cross-site-cookie: Controls access to OAuth state cookie between origins. Set to true in multi-cluster deployments in order to support OAuth clients that use POST callbacks. The default is false.

      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.account-url: The URL that points to the root of the Account app
      • console.ui.as.base-url: Base URL to the HTTP API
      • console.ui.as.enabled: Enable Application Server related functionality in the Console
      • console.ui.gs.base-url: Base URL to the HTTP API
      • console.ui.gs.enabled: Enable Gateway Server related functionality in the Console
      • console.ui.edtc.base-url: Base URL to the HTTP API
      • console.ui.edtc.enabled: Enable End Device Template Converter related functionality in the Console
      • console.ui.is.base-url: Base URL to the HTTP API
      • console.ui.is.enabled: Enable Identity Server related functionality in the Console
      • console.ui.js.base-url: Base URL to the HTTP API
      • console.ui.js.enabled: Enable Join Server related functionality in the Console
      • console.ui.ns.base-url: Base URL to the HTTP API
      • console.ui.ns.enabled: Enable Network Server related functionality in the Console
      • console.ui.qrg.base-url: Base URL to the HTTP API
      • console.ui.qrg.enabled: Enable QR Code Generator related functionality in the Console
      • console.ui.gcs.base-url: Base URL to the HTTP API
      • console.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 file
      • console.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 assets
      • console.ui.branding-base-url: The base URL to the branding assets
      • console.ui.branding-cluster-id Cloud Enterprise : The cluster ID to show below the logo
      • console.ui.branding-text Cloud Enterprise : The branding text to show below the logo
      • console.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 URL
      • console.ui.descriptions: The page description
      • console.ui.language: The page language
      • console.ui.site-name: The site name
      • console.ui.sub-title: The page sub-title
      • console.ui.support-link: The URI that the support button will point to
      • console.ui.documentation-base-url: The base URL for generating documentation links
      • console.ui.theme-color: The page theme color
      • console.ui.title: The page title
      • console.ui.cluster-picker-url: A URL to the a cluster picker to enable users to pick the correct cluster of the deployment

      Deployment Information and Disclaimers

      It is possible to highlight some deployment information and disclaimers in the header of the Console:

      • console.ui.fair-use-policy-information-url: A URL with information about the applicable fair use policy of the deployment
      • console.ui.sla-applies: The applicable Service Level Agreement of this deployment, e.g. >99.9%
      • console.ui.sla-information-url: A URL with information about the SLA applicable for this deployment
      • console.ui.support-plan-applies: The applicable support plan of this deployment, e.g. priority, 24h
      • console.ui.support-plan-information-url: A URL with information about the support plan applicable for this deployment
      • console.ui.sentry-dsn: The Sentry DSN

      DevEUI Generation Support

      Console supports generating DevEUIs from the configured DevEUI address block.

      • console.ui.dev-eui-issuing-enabled: To enable DevEUI issuing
      • console.ui.dev-eui-app-limit: Controls how many DevEUIs can be issued per an application

      Device Repository Options

      Device Repository component allows integrating Device Repository with The Things Stack.

      • dr.assets-base-url: The BaseURL of the Device Repository assets
      • dr.directory: Retrieve Device Repository from the filesystem
      • dr.source: Source of the Device Repository
      • dr.store.bleve.search-paths: Search paths for the Device Repository index files
      ← Command-Line Interface Options Device Claiming Server Options →

      On this page

      • Console Mount
      • OAuth Options
      • Frontend Setup

      Sections

      Getting Started

      Concepts

      Cloud

      Enterprise

      Integrations

      API

      Hardware

      Sitemap

      View our Sitemap

      Contributing

      GitHub

      About Us

      The Things Industries

      Privacy Policy

      Cookie settings

      Cookie Settings

      We use cookies to enhance your experience, analyze site traffic and deliver personalized content. Read our Privacy Policy.

      Cookie categories