Skip to content

Runtime Options

Overview

The dashboard ships with built-in runtime options that influence:

  • which route surfaces exist
  • how URLs are structured
  • what settings are available
  • how datatables behave
  • how toast notifications behave

This page collects the most important built-in options users and maintainers care about.

Feature Flags

The built-in runtime config defines four feature surfaces.

KeyPurposeDefault
features.website-api.enabledEnables the website API route grouptrue
features.dashboard-api.enabledEnables the dashboard API route grouptrue
features.dashboard-api.prefixPrefix used for dashboard API routesdashboard
features.website.enabledEnables website web routestrue
features.dashboard.enabledEnables dashboard web routestrue
features.dashboard.prefixPrefix used for dashboard web routesdashboard

Routing Options

KeyPurposeDefault
routing.append_locale_to_urlPrefixes web URLs with {locale}true
routing.redirect_non_locale_urlsRedirects non-localized web URLs when neededtrue

Locale Definitions

Default locale definitions include:

CodeNameRTL
enEnglishfalse
arالعربيةtrue

Settings Keys

The built-in settings schema includes these keys.

KeyDefaultNotes
app_logo_darkassets/images/logo-dark.svgUsed by <x-logo> in dark theme
app_logo_lightassets/images/logo-light.svgUsed by <x-logo> in light theme
app_namelocalized arrayUsed in UI and meta title
website_locales['en', 'ar']Enabled website locales
dashboard_locales['en', 'ar']Enabled dashboard locales
page_loader_enabledfalseEnables <x-page-loader> in dashboard layout
service_worker_enabledtrueEnables service worker registration in production
facebook_pixel_id''Injects pixel component when present
google_analytics_property_id''Injects GA component when present
cloudflare_turnstile_site_key''Used by captcha component
cloudflare_turnstile_secret_key''Used by server-side captcha validation
head_code''Injected into website layout head
body_code''Injected into website layout scripts stack
dashboard_sidebar_themeinheritSidebar theme setting
theme{ primary, base, font, radius }Used by themer runtime

Datatable Runtime Options

The built-in datatable config defines:

Asset Endpoints

KeyPurpose
assets.css.fileSource CSS file used for datatables
assets.css.uriPublic URI for datatable CSS
assets.css.routeRoute name that serves datatable CSS
assets.js.fileSource JS file used for datatables
assets.js.uriPublic URI for datatable JS
assets.js.routeRoute name that serves datatable JS

Export Options

KeyPurposeDefault
export.xlsx.enabledXLSX export supporttrue
export.csv.enabledCSV export supporttrue
export.json.enabledJSON export supporttrue
export.pdf.enabledPDF export supporttrue
export.pdf.templateBlade template for PDF exportdatatables::pdf.default
export.pdf.adapterPDF adapter classLaravelMpdf
export.pdf.options.formatPDF formatA4
export.pdf.options.orientationPDF orientationP

Toast Runtime Options

The toast system exposes:

CDN / Asset Paths

KeyDefault
cdn.js/vendor/toastify/toastify.min.js
cdn.css/vendor/toastify/toastify.min.css

Toast Types

Configured toastifiers include:

  • toast
  • error
  • success
  • info
  • warning

Each toastifier ships with predefined color and border styles that follow Tabler theme variables.

Default Toast Behavior

KeyDefault
defaults.gravitytoastify-bottom
defaults.positionright
defaults.closetrue

Practical Guidance

Use runtime options for:

  • enabling or disabling whole route surfaces
  • changing dashboard or API URL prefixes
  • defining platform-wide settings defaults
  • changing default datatable export behavior
  • tuning global toast behavior

All rights reserved.