Skip to content

Web Kiosk

A USB-booting NixOS image that turns an x86 computer into a locked-down Firefox kiosk for a single web page.

NixOSStableMIT
View on GitHub (opens in a new tab)
Platform

NixOS

License
MIT
Status
Stable
Repository

Lobby displays, sign-in stations, time clocks, and shop-floor dashboards all need the same thing: a computer that shows one web page and nothing else. Web Kiosk builds a minimal NixOS image that boots straight into Firefox's kiosk mode at the URL you choose and connects to your Wi-Fi on its own. Because it's NixOS, every kiosk built from the same configuration is identical.

Features

  • Firefox kiosk mode isolated to your start page.

  • USB deployment. Build an ISO, write it to a thumb drive or disc, and boot the target machine from it.

  • Wi-Fi built in. Bake the network name and password into the image for automatic connection, or leave them empty to use a wired network.

  • Configurable start page, time zone, screen brightness, and disabled services, all in flake.nix.

  • Reproducible and minimal. Only what the kiosk needs is included, with a QEMU test that boots the image.

Know the trade-offs: it runs on x86_64 hardware only, updates mean rebuilding and redeploying the image, and the ISO is about 1.6 GB.

Getting started

You need Nix with flakes and direnv. Clone the repository, set your start page and Wi-Fi in a .env file (the setup.sh script will prompt you), then build the ISO. The README walks through each step.

Related projects

All open-source projects

Reproducible Nix infrastructure for Frappe and ERPNext, from the development shell to OCI containers and a multi-site NixOS module.

odoo-nix

Active

Reproducible Nix infrastructure for Odoo Community (OCB) and OCA projects, from scaffolding and development to containers and NixOS.

A fast FrankenPHP WordPress stack built with Nix, deployable as OCI containers or a NixOS module, with MySQL, Cloudflare D1, or Turso databases.

Need help with it?

Need kiosks or shop-floor displays connected to your business system? See Devices and IoT.