Sleep Mode

Tip

You can add disable_sleep=true to your URL queries to bypass sleepmode.

Sleep Start

Time (in 24hr format) to start sleep mode

Settings

Key	Value
CONFIG	sleep_start
ENV	KIOSK_SLEEP_START
URL	sleep_start
VALUE	string
DEFAULT

Using with config.yaml file

sleep_start:

Using with ENV in your docker-compose file

environment:
  KIOSK_SLEEP_START:

Using with url queries

http://{URL}?sleep_start=

Sleep End

Time (in 24hr format) to end sleep mode

Settings

Key	Value
CONFIG	sleep_end
ENV	KIOSK_SLEEP_END
URL	sleep_end
VALUE	string
DEFAULT

Using with config.yaml file

sleep_end:

Using with ENV in your docker-compose file

environment:
  KIOSK_SLEEP_END:

Using with url queries

http://{URL}?sleep_end=

Sleep Icon

Display icon during sleep mode.

Settings

Key	Value
CONFIG	sleep_icon
ENV	KIOSK_SLEEP_ICON
URL	sleep_icon
VALUE	bool
DEFAULT	true

Using with config.yaml file

sleep_icon: true

Using with ENV in your docker-compose file

environment:
  KIOSK_SLEEP_ICON: true

Using with url queries

http://{URL}?sleep_icon=true

Sleep Dim Screen

Dim screen during sleep mode when using Fully Kiosk Browser

Settings

Key	Value
CONFIG	sleep_dim_screen
ENV	KIOSK_SLEEP_DIM_SCREEN
URL	sleep_dim_screen
VALUE	bool
DEFAULT	false

Using with config.yaml file

sleep_dim_screen: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SLEEP_DIM_SCREEN: false

Using with url queries

http://{URL}?sleep_dim_screen=false

Dimming the Screen with the ImmichFrame app

If you are running Kiosk within the ImmichFrame app, setting sleep_dim_screen=true will dim the screen during sleep mode.

Dimming the Screen with Fully Kiosk Browser

Caution

If you will need the pro version of Fully Kiosk Browser, and will need to turn on “Enable JavaScript Interface” in the Advanced Web Settings.

If you are running Kiosk within the Fully Kiosk Browser, setting sleep_dim_screen=true will dim the screen during sleep mode.

Disable Sleep

Bypass sleep mode by adding disable_sleep=true to the URL

Settings

Key	Value
CONFIG	disable_sleep
ENV	N/A
URL	disable_sleep
VALUE	bool
DEFAULT	false

Using with config.yaml file

disable_sleep: false

Using with url queries

http://{URL}?disable_sleep=false

Enabling Sleep Mode

Setting both sleep_start and sleep_end using the 24-hour format will enable sleep mode.

During Sleep Mode

Kiosk will display a black screen and can optionally show a faint clock if show_time or show_date and enabled.

Examples

• Setting sleep_start=22 and sleep_end=7 will enable sleep mode from 22:00 (10pm) to 07:00 (7am).
• Setting sleep_start=1332 and sleep_end=1508 will enable sleep mode from 13:32 (1:32pm) to 15:08 (3:08pm).