Skip to content

Getting Started

Recogito Studio is a modern, open-source platform for collaborative annotation of TEI text, IIIF images, and PDFs. This documentation covers everything you need to self-host your own instance.

What is Recogito Studio?

Section titled “What is Recogito Studio?”

Recogito Studio provides:

  • Collaborative Annotation: Multiple users can annotate documents simultaneously
  • Standards-Based: Built on TEI, IIIF, and other open standards
  • Multi-Format Support: Works with text, images, and PDF documents
  • Extensible Platform: Plugin architecture for custom functionality

Local Development Setup & Self-Hosting

Section titled “Local Development Setup & Self-Hosting”

Complete Installation

Full Docker-based deployment with all services included. Perfect for production environments.

View Self-Hosting Guide →

System Requirements

Section titled “System Requirements”

Before you begin, ensure you have:

  • Server: Ubuntu Linux (v24 recommended)
  • Memory: Minimum 4GB RAM
  • Storage: 50GB+ available space
  • Network: Public IP with domain access
  • DNS: Ability to create 5+ DNS records

Architecture Overview

Section titled “Architecture Overview”

Recogito Studio consists of several integrated components:

  • Client Application (Astro.js) - User interface
  • Server Platform (Supabase) - Backend services
  • Database (PostgreSQL) - Data storage
  • File Storage (MinIO) - Document and media files
  • Management Tools (Portainer, pgAdmin) - Administration

Next Steps

Section titled “Next Steps”
  1. Review Requirements: Ensure your server meets the system requirements
  2. Prepare Domains: Set up DNS records for your installation
  3. Follow Installation: Complete the self-hosting guide
  4. Configure & Customize: Adapt the platform to your needs

Need Help?

Section titled “Need Help?”