Device Claiming Server Mount
The Device Claiming Server can be served under any arbitrary path on your server
dcs.mount
: Path on the server where the Device Claiming Server will be served
OAuth Options
The Device Claiming app uses the OAuth 2.0 authorization flow to authorize actions in the backend. You can customize the authorization parameters if necessary:
dcs.oauth.authorize-url
: The OAuth Authorize URLdcs.oauth.client-id
: The OAuth client IDdcs.oauth.client-secret
: The OAuth client secretdcs.oauth.token-url
: The OAuth Token Exchange URLdcs.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 Device Claiming Server 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 Device Claiming Server frontend to be disabled.
dcs.ui.as.base-url
: Base URL to the HTTP APIdcs.ui.as.enabled
: Enable Application Server related functionality in the Device Claiming Serverdcs.ui.is.base-url
: Base URL to the HTTP APIdcs.ui.is.enabled
: Enable Identity Server related functionality in the Device Claiming Serverdcs.ui.js.base-url
: Base URL to the HTTP APIdcs.ui.js.enabled
: Enable Join Server related functionality in the Device Claiming Serverdcs.ui.dcs.base-url
: Base URL to the HTTP APIdcs.ui.dcs.enabled
: Enable Device Claiming Server related functionality in the Device Claiming Server (must betrue
for the frontend to work)dcs.ui.ns.base-url
: Base URL to the HTTP APIdcs.ui.ns.enabled
: Enable Network Server related functionality in the Device Claiming Server
File Includes
You can control which CSS and JavaScript files are included into the rendered HTML of the Device Claiming Server. Note that these files must be present in the /public
folder during runtime.
dcs.ui.js-file
: The names of the JavaScript filedcs.ui.css-file
: The names of the CSS files
Assets and Custom Branding
You can control the url of the assets folder that the Device Claiming Server 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.
dcs.ui.assets-base-url
: The base URL to the page assetsdcs.ui.branding-base-url
: The base URL to the branding assetsdcs.ui.branding-cluster-id
: The cluster ID to show below the logo
dcs.ui.branding-text
: The branding text to show below the logo
dcs.ui.icon-prefix
: The prefix to put before the page icons (favicon.ico, touch-icon.png, og-image.png)dcs.ui.canonical-url
: The page canonical URLdcs.ui.descriptions
: The page descriptiondcs.ui.language
: The page languagedcs.ui.site-name
: The site namedcs.ui.sub-title
: The page sub-titledcs.ui.support-link
: The URI that the support button will point todcs.ui.documentation-base-url
: The base URL for generating documentation linksdcs.ui.theme-color
: The page theme colordcs.ui.title
: The page title