Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Tymeslot/tymeslot/llms.txt

Use this file to discover all available pages before exploring further.

Tymeslot gives you booking pages, two-way calendar sync, video room creation, embeddable widgets, and automated emails — all running on your own infrastructure under the AGPLv3 licence. It’s the same codebase that powers tymeslot.app, so what you self-host is what paying cloud customers use in production.

Docker Quickstart

Get a full Tymeslot instance running in one command with embedded PostgreSQL.

Cloudron

One-click install on Cloudron with automatic SSL, updates, and backups.

Railway

Deploy to Railway’s managed cloud infrastructure in minutes.

Configuration Reference

All environment variables — SMTP, OAuth, database, encryption, and more.

What’s included

Every feature ships in the box — no add-ons, no per-feature upsells.

Calendar Sync

Two-way sync with Google Calendar, Outlook, Apple iCloud, and any CalDAV server.

Video Rooms

Auto-create Google Meet, Teams, Zoom, or MiroTalk rooms on booking.

Webhooks

Fire meeting events to n8n, Zapier, Make, or your own backend.

Embed Widget

Inline, popup, or floating button — paste one snippet anywhere.

SSO & OAuth

Google, GitHub, and generic OIDC for Keycloak, Authentik, Okta, Azure AD.

Stripe Payments

Optional paid bookings via Stripe Connect — fee-free for self-hosters.

Deploy your way

1

Pick a deployment method

Run the Docker image on any VPS, install on Cloudron, deploy to Railway, or sign up for the managed cloud at tymeslot.app.
2

Set required environment variables

At minimum you need SECRET_KEY_BASE, PHX_HOST, and POSTGRES_PASSWORD. Everything else has sensible defaults. See the Environment Variables reference.
3

Configure email

Set EMAIL_ADAPTER=smtp or EMAIL_ADAPTER=postmark so booking confirmations, reminders, and password resets are delivered. See Email Configuration.
4

Connect your calendars and video

Link Google Calendar, Outlook, CalDAV, and a video provider from the dashboard. Follow the Integrations guides for OAuth app setup.
The first account you create on a fresh install is automatically promoted to admin and gains access to /admin. See Admin Management for promoting additional admins.

Build docs developers (and LLMs) love