User Interface

Disable navigation

Disable all Kiosk’s navigation (touch/click, keyboard and menu).

Settings

Key	Value
CONFIG	disable_navigation
ENV	KIOSK_DISABLE_NAVIGATION
URL	disable_navigation
VALUE	bool
DEFAULT	false

Using with config.yaml file

disable_navigation: false

Using with ENV in your docker-compose file

environment:
  KIOSK_DISABLE_NAVIGATION: false

Using with url queries

http://{URL}?disable_navigation=false

Disable UI

A shortcut to set show_time, show_date, show_image_time and image_date_format to false.

Settings

Key	Value
CONFIG	disable_ui
ENV	KIOSK_DISABLE_UI
URL	disable_ui
VALUE	bool
DEFAULT	false

Using with config.yaml file

disable_ui: false

Using with ENV in your docker-compose file

environment:
  KIOSK_DISABLE_UI: false

Using with url queries

http://{URL}?disable_ui=false

Menu position

Set the position of the menu bar.

Settings

Key	Value
CONFIG	menu_position
ENV	KIOSK_MENU_POSITION
URL	menu_position
VALUE	top | bottom
DEFAULT	top

Using with config.yaml file

menu_position: top

Using with ENV in your docker-compose file

environment:
  KIOSK_MENU_POSITION: top

Using with url queries

http://{URL}?menu_position=top

Frameless

Remove borders and rounded corners on images.

Settings

Key	Value
CONFIG	frameless
ENV	KIOSK_FRAMELESS
URL	frameless
VALUE	bool
DEFAULT	false

Using with config.yaml file

frameless: false

Using with ENV in your docker-compose file

environment:
  KIOSK_FRAMELESS: false

Using with url queries

http://{URL}?frameless=false

Frame padding New

Add padding around the outside of Kiosk.

Settings

Key	Value
CONFIG	frame_padding
ENV	KIOSK_FRAME_PADDING
URL	frame_padding
VALUE	int | []int
DEFAULT	0

Using with config.yaml file

frame_padding: 0

Using with ENV in your docker-compose file

environment:
  KIOSK_FRAME_PADDING: 0

Using with url queries

http://{URL}?frame_padding=0

Frame padding examples

Single padding

frame_padding: 10 ## add 10px padding around the outside of Kiosk

Top and bottom padding

frame_padding: [10, 20] ## add 10px padding top and bottom, 20px padding right and left

Top, right, left and bottom padding

frame_padding: [10, 20, 30, 40] ## add 10px padding top, 20px padding right, 30px padding bottom, 40px padding left

URL params

Add 10px top and bottom and 20px left and right padding via URL

https://example.com?frame_padding=10&frame_padding=20

Add 10px top, 20px right, 30px bottom and 40px left padding via URL

https://example.com?frame_padding=10&frame_padding=20&frame_padding=30&frame_padding=40

Hide cursor

Hide cursor/mouse via CSS.

Settings

Key	Value
CONFIG	hide_cursor
ENV	KIOSK_HIDE_CURSOR
URL	hide_cursor
VALUE	bool
DEFAULT	false

Using with config.yaml file

hide_cursor: false

Using with ENV in your docker-compose file

environment:
  KIOSK_HIDE_CURSOR: false

Using with url queries

http://{URL}?hide_cursor=false

Font size

The base font size for Kiosk. Default is 100% (16px). DO NOT include the % character.

Settings

Key	Value
CONFIG	font_size
ENV	KIOSK_FONT_SIZE
URL	font_size
VALUE	int
DEFAULT	100

Using with config.yaml file

font_size: 100

Using with ENV in your docker-compose file

environment:
  KIOSK_FONT_SIZE: 100

Using with url queries

http://{URL}?font_size=100

Background blur

Display a blurred version of the image as a background.

Settings

Key	Value
CONFIG	background_blur
ENV	KIOSK_BACKGROUND_BLUR
URL	background_blur
VALUE	bool
DEFAULT	true

Using with config.yaml file

background_blur: true

Using with ENV in your docker-compose file

environment:
  KIOSK_BACKGROUND_BLUR: true

Using with url queries

http://{URL}?background_blur=true

Background blur amount

The amount of blur to apply to the background image (sigma).

Settings

Key	Value
CONFIG	background_blur_amount
ENV	KIOSK_BACKGROUND_BLUR_AMOUNT
URL	background_blur_amount
VALUE	int
DEFAULT	10

Using with config.yaml file

background_blur_amount: 10

Using with ENV in your docker-compose file

environment:
  KIOSK_BACKGROUND_BLUR_AMOUNT: 10

Using with url queries

http://{URL}?background_blur_amount=10