Byonk

Bring Your Own Ink - A self-hosted content server for TRMNL e-ink devices.

Byonk lets you create custom screens for your TRMNL device using Lua scripts and SVG templates. Fetch data from any source, render it beautifully, and display it on your e-ink screen.

Quick Start

docker run --rm -it --pull always -p 3000:3000 ghcr.io/oetiker/byonk:latest

Point your TRMNL device to http://your-server:3000 and it will start displaying content.

Home Assistant

Byonk installs itself as a Home Assistant app, and brings its own integration with it — device onboarding, entities, and automatic token provisioning:

1. In Home Assistant, go to Settings → Apps → App store.
2. Open the ⋮ menu, choose Repositories, add https://github.com/oetiker/byonk and select Add.
3. Find Byonk in the store, select Install, then Start.
4. Byonk asks you to restart Home Assistant. Do that (Settings → System → Restart).
5. After the restart, a Byonk card is waiting in Settings → Devices & Services. Select Add.

See the Home Assistant guide for details.

Dev Mode

Byonk has a built-in screen editor: pick a screen, edit its Lua and SVG, and watch the rendered result beside them. It is part of the normal server, at /dev/, behind a login you enable by setting a username and a password:

docker run --rm -it --pull always -p 3000:3000 \
  -e BYONK_DEV_USERNAME=me -e BYONK_DEV_PASSWORD=secret \
  ghcr.io/oetiker/byonk:latest

Then open http://localhost:3000/dev/ in your browser:

Documentation

Full documentation is available at oetiker.github.io/byonk:

• Installation Guide
• Home Assistant
• Configuration
• Creating Your First Screen
• Lua API Reference
• HTTP API
• Admin API
• Dev Mode

License

MIT License - see LICENSE