Display Kiosk Setup

Get your new TV screen up and running in 3 simple steps.

1

Download the Brain

First, we need to download the operating system that makes the screen work. This is a large file, so it might take a minute.

Download Display Image (kiosk.img.zst)

Note: You will need to flash this .img.zst file to an SD card using a tool like Raspberry Pi Imager or BalenaEtcher.

2

Give it Instructions

Once you have flashed the SD card, leave it plugged into your computer. It will show up as a thumb drive named NIXOS_SD.

Download the configuration file below, open it in Notepad (or TextEdit), type in your WiFi password and the web address you want it to show, and save it directly onto that thumb drive.

📁 NIXOS_SD (Boot Partition)
├── 📄 bcm2711-rpi-4-b.dtb
├── 📄 boot.scr
├── 📄 kiosk.env # <-- Drop your edited kiosk.env right here!
└── 📁 overlays/
Download kiosk.env template
3

Plug it In!

That's it! Eject the SD card from your computer and slide it into the Raspberry Pi behind the TV. Plug in the power cord.

The screen will turn on, automatically connect to the internet, and show your layout within 60 seconds.

Example kiosk.env text file representing all variables
HOSTNAME=lobby-screen

# Connect to WiFi:
WIFI_SSID=My Network Name
WIFI_PASS=MySecretPassword

# What to Show: (Use file:/// for a local index.html!)
URL=https://my-company-dashboard.com

# Display Configuration
# 0=Normal, 90=Left, 180=Upside-down, 270=Right
ORIENTATION=0
ZOOM_FACTOR=1.0
HIDE_CURSOR=true

# Security Configuration
# By default the password is 'kiosk'. Leave ENABLE_SSH true for remote management.
ENABLE_SSH=true
# (Optional) If you add an SSH key, password login is automatically disabled.
SSH_KEY=ssh-ed25519 AAAAC3Nza...