Telescreen documentation
Your family day, on the wall.
New here? Start with Overview, then Install.
Start
- Overview — what Telescreen does and what it does not.
- Install — Docker, HTTPS on your tailnet, and the first launch.
- First run — name the household, add people, and connect a calendar.
Use Telescreen
- Calendar — views, navigation, member filters, and wall-display behavior.
- Events — create, edit, repeat, and delete events.
- Chores — recurring and rotating chores, completion, and progress.
- Meals — the week board, tonight's meal, and the kitchen sidebar.
- Music — now playing and playback controls.
- Weather — forecast card, hourly view, and UV index.
- Travel — driving times, traffic status, and arrival times.
- Settings — household, members, modules, and appearance.
Connect
- Google Calendar — OAuth client and calendar sync.
- iCloud — app-specific password and CalDAV.
- Spotify — a Spotify app for playback control.
- PantryPal — meals, recipes, and the shopping list.
Host Telescreen
- Configuration — environment variables and storage.
- Deployment — Docker Compose and Tailscale HTTPS.
- Access and security — tokens, trust mode, and secrets.
- Backups and restore — save and recover the database.
- Updates — build a new version and apply migrations.
- Troubleshooting — checks for common problems.
Develop and contribute
- Local setup — run the API and web app.
- Tests and checks — typecheck, unit tests, and end-to-end runs.
- Architecture — code layout and data rules.
- Contribute — issues and pull requests.
- Documentation site — edit, preview, and publish these guides.
Reference
- REST API — endpoints, errors, and OpenAPI.
- CLI commands — API tokens.
- Environment variables — every variable and its default.