Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ptshen/timeful-plus/llms.txt

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

Timeful helps groups find the best time to meet. Create an availability poll, share the link, and watch responses roll in — with optional calendar sync so participants never have to manually enter their free times. This fork is tailored for the Columbia Math Department with extended features like configurable time-slot capacity limits and a 1-hour default time increment.

Quickstart

Self-host Timeful in under 5 minutes with Docker Compose and pre-built images.

Configuration

Reference every environment variable and the frontend config.js options.

Features

Explore availability polls, calendar integrations, groups, and sign-up forms.

API Reference

Browse the full REST API — events, users, folders, and authentication.

What Timeful Does

Timeful is a free group-scheduling tool similar to when2meet, but with richer calendar integration and more control over how meetings are organized. Participants can connect their Google, Outlook, or Apple calendars so Timeful auto-fills their availability — no manual entry needed.

Availability Polls

Poll by specific dates or day-of-week patterns, with optional time-slot capacity limits.

Calendar Sync

Connect Google, Outlook, or Apple Calendar to auto-populate availability.

Availability Groups

Monitor a team’s real-time calendar availability without creating a new poll each time.

Sign-Up Forms

Let participants claim specific time slots rather than just mark availability.

Premium Features

All premium features are automatically unlocked for self-hosted deployments.

Production Deployment

Run Timeful behind Nginx or Caddy with HTTPS on your own domain.

Self-Hosting in 3 Steps

1

Install Docker and Docker Compose

Make sure Docker 20.10+ and Docker Compose v2 are installed on your server.
2

Configure your environment

Copy .env.example to .env and set your ENCRYPTION_KEY. Add Google OAuth credentials if you want calendar integration.
3

Start Timeful

Run docker compose -f docker-compose.ghcr.yml up -d to pull pre-built images and start the app at http://localhost:3002.
All premium features — blind availability, email notifications, CSV export, and more — are automatically unlocked for self-hosted deployments. No Stripe account required.

Build docs developers (and LLMs) love