Skip to Content
DocumentationGuidesCustom settings

Custom settings

You can change the default settings by creating a settings.json file in runtipi/state/settings.json. This file makes 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 dashboardstringexample.com
portThe port to use for the dashboardinteger80
sslPortThe port to use for the dashboard with SSLinteger443
listenIpThe IP address to listen onstringautomatically detected
appDataPathBase path to use for storing app data. Runtipi appends /app-data for you.stringruntipi
localDomainThe domain name to use for local servicesstringtipi.lan
appsRepoUrlThe URL to the apps repositorystringhttps://github.com/runtipi/runtipi-appstore
postgresPortThe port to use for the postgres databaseinteger5432
demoModeEnable demo restrictions. See security limitations.booleanfalse
guestDashboardAllow guest access to the dashboardbooleanfalse
allowErrorMonitoringWhether the app will send anonymous crash reports to the Runtipi developersbooleanfalse
allowAutoThemesEnables thematically changing the dashboard based on the time of the yearbooleantrue
persistTraefikConfigDo not replace the Traefik config on every restart of Runtipibooleanfalse
trustedProxyIpsComma-separated proxy IPs or CIDRs Traefik should trust for forwarded headersstringempty
eventsTimeoutThe time in minutes to wait for an action to complete before timing outinteger5
advancedSettingsShow advanced settings in the dashboardbooleanfalse
forwardAuthUrlOverride the Traefik forward-auth endpointstringhttp://runtipi:3000/api/auth/traefik
logLevelBackend log levelstringinfo
maxBackupsMaximum number of backups to keep per appinteger0
timeZoneTimezone used by Runtipi and many appsstringsystem timezone
themeBaseDashboard base themestringgray
themeColorDashboard accent colorstringblue
experimental_insecureCookieDisable secure cookie handling for debugging onlybooleanfalse

Demo mode security limitations

Demo mode does not guarantee security or provide isolation from the host. A demo user may still find ways around its restrictions, including creating custom apps with root access to the host. Do not rely on demoMode to protect your server or data from untrusted users.

Only share demo access with people you trust with administrative access to the host. If you run a demo instance, use a separate, disposable host with no sensitive data or access to your private network.

Last updated on