Skip to Content

Custom settings

You can change the default settings by creating a settings.json file. The file should be located in the cihome/state directory. This file will make your changes persist across restarts. Example file:

{ "dnsIp": "9.9.9.9", "domain": "mydomain.com" }

Be sure that the content is a valid JSON format. You can easily check for validity in an online tool like JSONLint 

Available settings:

ParameterDescriptionTypeDefault value
dnsIpThe IP address of the DNS server to use. Legacy, kept for compatibilitystring9.9.9.9
domainThe domain name to use for the dashboardstringlocalhost
portThe port to use for the dashboardinteger80
sslPortThe port to use for the dashboard with SSLinteger443
listenIpThe IP address to listen onstringautomatically detected
appDataPathThe path to use for storing datastringapp-data
localDomainThe domain name to use for local servicesstringtipi.lan
appsRepoUrlThe URL to the apps repositorystring(built-in)
postgresPortThe port to use for the postgres databaseinteger5432
demoModeStart Companion Home in demo modebooleanfalse
guestDashboardAllow guest access to the dashboardbooleanfalse
allowErrorMonitoringWhether the app will send anonymous crash reports to the Companion Home developersbooleantrue
allowAutoThemeEnables thematically changing the dashboard based on the time of the yearbooleantrue
persistTraefikConfigDo not replace the traefik config on every restart.booleantrue
eventsTimeoutThe time in minutes to wait for an action to complete before timing outinteger5
Last updated on