Getting Started
Custom Settings

Custom settings

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

  "dnsIp": "",
  "domain": ""

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

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 dashboardinterger80
sslPortThe port to use for the dashboard with SSLinterger443
listenIpThe IP address to listen onstringautomatically detected
appDataPathThe path to use for storing datastringruntipi/app-data
localDomainThe domain name to use for local servicesstringtipi.lan
appsRepoUrlThe URL to the apps repositorystring
postgresPortThe port to use for the postgres databaseinterger5432
demoModeStart tipi in demo modebooleanfalse
guestDashboardAllow guest access to the dashboardbooleanfalse
allowErrorMonitoringWhether the app will send anonymous crash reports to the runtipi developersbooleantrue
allowAutoThemeEnables thematically changing the dashboard based on the time of the yearbooleantrue
persistTraefikConfigDo not replace the traefik config on every restart of tipi.booleantrue