Latest commit

History

Folders and files

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
.yarn/releases		.yarn/releases
assets/sample-photos		assets/sample-photos
device-client		device-client
docs		docs
e2e		e2e
packages		packages
scripts		scripts
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.env.example		.env.example
.gitattributes		.gitattributes
.gitignore		.gitignore
.nvmrc		.nvmrc
.yarnrc.yml		.yarnrc.yml
AGENTS.md		AGENTS.md
CLAUDE.md		CLAUDE.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
biome.json		biome.json
eslint.config.js		eslint.config.js
inkcast.config.example.json		inkcast.config.example.json
package.json		package.json
playwright.config.ts		playwright.config.ts
tsconfig.base.json		tsconfig.base.json
tsconfig.json		tsconfig.json
vitest.config.ts		vitest.config.ts
yarn.lock		yarn.lock

Repository files navigation

CastKit

Set up CastKit with Docker →

CastKit is a self-hostable home display platform. One server drives image and browser displays over MQTT, while Home Assistant supplies view data, selects active views, and executes device commands.

CastKit supports two client modes:

Inkcast (image) renders and dithers views on the server, then sends PNGs to small ePaper receivers.
Slatecast (browser) serves a small Preact client for live and touch-capable displays.

Run with Docker

Complete the setup guide before you start the server. A useful installation needs an MQTT broker and a device configuration file.

docker run --rm --env-file .env -p 8788:8788 \
 -v "$PWD/inkcast.config.json:/config/devices.json:ro" \
 -e INKCAST_DEVICES_FILE=/config/devices.json \
 ghcr.io/sawtaytoes/castkit:latest

Run from source

corepack yarn install
corepack yarn playwright install chromium
corepack yarn build
corepack yarn start:prod

Use corepack yarn dev for the browser preview and corepack yarn dev:server for the server during development.

Documentation

CastKit is available under the MIT License.

About

CastKit: self-hostable home display platform. One server, two client modes — Inkcast (server-rendered e-ink image push over MQTT) and Slatecast (browser-rendered interactive touch kiosks). Home Assistant is the brain via MQTT discovery.