Files
UnrealEngine/Engine/Source/Programs/Horde/Docs/Config/Schema/Dashboard.md
2025-05-18 13:04:45 +08:00

2.1 KiB

Horde > Configuration > *.dashboard.json

*.dashboard.json

Configuration for dashboard features

Name Description
showLandingPage boolean
Navigate to the landing page by default
landingPageRoute string
Custom landing page route to direct users to
showCI boolean
Enable CI functionality
showAgents boolean
Whether to show functionality related to agents, pools, and utilization on the dashboard.
showAgentRegistration boolean
Whether to show the agent registration page. When using registration tokens from elsewhere this is not needed.
showPerforceServers boolean
Show the Perforce server option on the server menu
showDeviceManager boolean
Show the device manager on the server menu
showTests boolean
Show automated tests on the server menu
agentCategories DashboardAgentCategoryConfig[]
Configuration for different agent pages
poolCategories DashboardPoolCategoryConfig[]
Configuration for different pool pages
include ConfigInclude[]
Includes for other configuration files
macros ConfigMacro[]
Macros within this configuration

DashboardAgentCategoryConfig

Configuration for a category of agents

Name Description
name string
Name of the category
condition string
Condition string to be evaluated for this page

DashboardPoolCategoryConfig

Configuration for a category of pools

Name Description
name string
Name of the category
condition string
Condition string to be evaluated for this page

ConfigInclude

Directive to merge config data from another source

Name Description
path string
Path to the config data to be included. May be relative to the including file's location.

ConfigMacro

Declares a config macro

Name Description
name string
Name of the macro property
value string
Value for the macro property