Skip to content

usetrmnl/inker

Repository files navigation

Buy Me A Coffee

Self-hosted e-ink device management system for TRMNL devices and devices compatible with TRMNL 1.6.9 software. Design screens, create custom widgets, and manage your displays from a modern web interface.

Dashboard

Features

  • Screen Designer — Drag & drop widget placement, snap guides, freehand drawing, export/import
  • Built-in Widgets — Clock, date, text, weather, countdown, days until, QR code, image, GitHub stars, battery, WiFi, device info
  • Custom Widgets — Connect to any JSON API or RSS feed, field extraction, JavaScript transformations, grid layouts
  • Playlists — Rotate multiple screens on devices automatically
  • Device Management — Auto-provisioning, real-time status, configurable refresh rates, logs

Screenshots

Screen Designer Devices Screens
Devices Screens Screen Designer
List of sources Custom Data Sources Custom Widgets
Extensions Custom data sources Custom widgets

Quick start

git clone https://github.com/wojo-o/inker.git
cd inker
cp .env.example .env    # optionally edit settings
docker compose up -d --build

Open http://your-server-ip:80 and log in with PIN 1111.

First start takes a few minutes to build. Subsequent starts are instant.

Configuration

Copy .env.example to .env and edit as needed:

Variable Description Default
ADMIN_PIN Login PIN 1111
POSTGRES_PASSWORD Database password inker_password
TZ Timezone for widgets UTC
JWT_SECRET Session signing key dev default
INKER_PORT Frontend port 80

License

Source Available — see LICENSE for details.

About

BYOS server written in TypeScript / React / Prisma

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages