Config Options

These can be set in config.json under the config platform.

auth

• Type: string
• Default: form
• Permitted Values: form, none
• Description: The authentication method the UI should use.

debug

• Type: boolean
• Default: false
• Description: Enable debug logging

homebridgePackagePath

• Type: string
• Default: undefined
• Description: The path where the Homebridge package is installed. If the Homebridge package is installed globally this is not required.

host

• Type: string
• Default: 0.0.0.0
• Description: The IP address of the interface the UI should listen on. By default the UI will listen on all interfaces.

lang

• Type: string
• Default: undefined
• Description: Set the Language the UI should use. Must be one of these supported languages. If not set the browser's lanugage settings will be used instead.

log

• Type: object
• Default: undefined
• Description: See log viewer configuration.

loginWallpaper

• Type: string
• Default: undefined
• Description: The path to an image that should be used on the UI login page. If this is not defined the default login wallpaper will be used.

name

• Type: string
• Default: undefined
• Permitted Values: Config
• Description: The name Homebridge uses to refer to the plugin.

noFork

• Type: boolean
• Default: false
• Description: Tells the UI not to spawn a separate process to run the UI in. Setting this value to true will mean the UI runs in the same process as the rest of your Homebridge plugins.

platform

• Required
• Type: string
• Default: undefined
• Permitted Values: config
• Description: Must be set to config.

port

• Type: integer
• Default: 8080
• Description: The port the web service should listen on.

proxyHost

• Type: string
• Default: undefined
• Description: The host and port example.com:8080 you will be accessing the UI on. This is only required if you are the UI behind a reverse proxy and are not passing through the host from the browser.

restart

• Type: string
• Default: undefined
• Description: The command that will be executed when the restart command is sent from the UI. If no command is defined the current process will be terminated instead.

scheduledBackupDisable

• Type: boolean
• Default: undefined
• Description: Set too true to disable the daily scheduled backups.

scheduledBackupPath

• Type: string
• Default: ./backups/instance-backups/
• Description: The full path to an existing directory where the automated daily backup archives should be saved. The service account Homebridge is running as MUST have read / write access to this directory.

sessionTimeout

• Type: integer
• Default: 28800
• Description: The number of seconds a login session will last for. The default is equal to 8 hours.

ssl

• Type: object
• Default: undefined
• Description: See enabling ssl.

standalone

• Type: boolean
• Default: false
• Description: This will prevent the UI from starting as part of Homebridge. Only set this if you are running the UI in standalone mode.

sudo

• Type: boolean
• Default: false
• Description: Tells the UI to use sudo for certain command such as retrieving logs, or installing plugins. See sudo for more information.

temp

Deprecated

• Type: string
• Default: undefined
• Description: The path to a file containing your CPUs current temperature information. This is only used as a backup if the CPU temperature cannot be determined automatically.

tempUnits

• Type: string
• Default: c
• Permitted Values: c, f
• Description: The temperature units that will be used in the UI.

theme

• Type: string
• Default: teal
• Permitted Values: See themes.
• Description: The color scheme / theme the user interface should use.