Home

Teedy documentation

Self-hoster documentation for this fork of Teedy. Start with getting started, then dip into the reference pages as needed.

Contents

Page	What it covers
Getting started	Docker Compose quick start (H2 for testing, PostgreSQL for production), first login, and changing the admin password
Configuration	The complete environment-variable and JVM -D property reference, plus the data directory and backup
Authentication	Local login, OIDC/SSO (Authelia & generic), reverse-proxy/oauth2-proxy header auth, LDAP, 2FA, the provisioning contract, and a login-failure troubleshooting table
Documents	Files and versions, relations, viewer rotation, bulk operations, PDF / full-account export, custom metadata, the activity trail, and the trash
Tags & filtering	Tags and nesting, clickable tag chips, auto-tagging rules, saved filters, and the full search-query syntax
Inbox scanning	Import email into Teedy over IMAP: connection setup, how mail becomes a document, auto-tagging, and delete-after-import
Cookbook	End-to-end recipes wiring the features together — invoice intake, self-hosted setup, paper archive, team review, scripted ingestion, and lifecycle management
Vocabulary	Admin-managed controlled value lists that back dropdown metadata fields
Workflows	Multi-step approval routes: concepts, lifecycle, webhooks, and two worked sample workflows
Sharing & permissions	ACLs, hierarchical groups, guest access, public share links, and comments
Admin guide	Users and quotas, webhooks, tag rules, audit log, branding, and SMTP/OCR settings
REST API	Authentication methods (session vs API key), request format, key resources, and curl examples
FAQ & troubleshooting	Common failures and their fixes, with pointers to the deeper pages

Related documents at the repository root

• RECOVERY.md — account and admin recovery paths (with and without SMTP)
• SECURITY.md — how to report a security vulnerability
• CHANGELOG.md — release history
• README.md — project overview and fork highlights
• docs-importer — a standalone Node.js tool for a one-off or watched bulk import of files from a local folder (separate from the built-in IMAP inbox scanning)