Clock

Time

Display the current time.

Settings

Key	Value
CONFIG	show_time
ENV	KIOSK_SHOW_TIME
URL	show_time
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_time: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_TIME: false

Using with url queries

http://{URL}?show_time=false

Time Format

Display clock time in either 12-hour or 24-hour format. This can either be 12 or 24.

Settings

Key	Value
CONFIG	time_format
ENV	KIOSK_TIME_FORMAT
URL	time_format
VALUE	24 | 12
DEFAULT	24

Using with config.yaml file

time_format: 24

Using with ENV in your docker-compose file

environment:
  KIOSK_TIME_FORMAT: 24

Using with url queries

http://{URL}?time_format=24

Show AM/PM

Hide the AM/PM suffix on the 12-hour clock.

Settings

Key	Value
CONFIG	show_am_pm
ENV	KIOSK_SHOW_AM_PM
URL	show_am_pm
VALUE	bool
DEFAULT	true

Using with config.yaml file

show_am_pm: true

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_AM_PM: true

Using with url queries

http://{URL}?show_am_pm=true

Show Seconds

Display seconds.

Settings

Key	Value
CONFIG	show_seconds
ENV	KIOSK_SHOW_SECONDS
URL	show_seconds
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_seconds: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_SECONDS: false

Using with url queries

http://{URL}?show_seconds=false

Date

Display the date.

Settings

Key	Value
CONFIG	show_date
ENV	KIOSK_SHOW_DATE
URL	show_date
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_date: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_DATE: false

Using with url queries

http://{URL}?show_date=false

Date Format

The format of the date. default is day/month/year.

Settings

Key	Value
CONFIG	date_format
ENV	KIOSK_DATE_FORMAT
URL	date_format
VALUE	string
DEFAULT	DD/MM/YYYY

Using with config.yaml file

date_format: DD/MM/YYYY

Using with ENV in your docker-compose file

environment:
  KIOSK_DATE_FORMAT: DD/MM/YYYY

Using with url queries

http://{URL}?date_format=DD/MM/YYYY

Date format

Note

Some characters, such as / and : are not allowed in URL params. So while you can set the date layout via URL params, I would suggest setting them via config.yaml or environment variables.

You can use the below values to create your preferred date layout.

| Value | Example output | |-------------|---------------------| | YYYY | 2024 | | YY | 24 | | MMMM | August | | MMM | Aug | | MM | 08 | | M | 8 | | DDDD | Monday | | DDD | Mon | | DD | 04 | | D | 4 |

Date layout examples

These examples assume that today’s date is the 22nd of August 2024.

• “YYYY-MM-DD” => “2024-08-22”
• “YYYY/MM/DD” => “2024/08/22”
• “YYYY:MM:DD” => “2024:08:22”
• “YYYY MM DD” => “2024 08 22”
• “YYYY MMM (DDD)” => “2024 Aug (Thur)”
• “DDDD DD MMMM YYYY” => “Thursday 22 August 2024”

---

Clock Source

The source of the clock. Either client or server.

Settings

Key	Value
CONFIG	clock_source
ENV	KIOSK_CLOCK_SOURCE
URL	clock_source
VALUE	client | server
DEFAULT	client

Using with config.yaml file

clock_source: client

Using with ENV in your docker-compose file

environment:
  KIOSK_CLOCK_SOURCE: client

Using with url queries

http://{URL}?clock_source=client