Getting Started
Installation Options

Installation Options

TimeTiles can be deployed in several ways depending on your needs and technical requirements.

Cloud Deployment (Recommended for Most Users)

Coming soon - we're working on cloud hosting options for easy access.

Self-Hosted Deployment

For organizations that need full control over their data or want to customize the platform.

System Requirements

  • Node.js: 24 or higher
  • Database: PostgreSQL 17+ with PostGIS 3.5+ extension
  • Memory: Minimum 4GB RAM (8GB+ recommended for production)
  • Storage: SSD recommended for optimal performance

Docker Deployment (Recommended)

The fastest way to get TimeTiles running locally or on your own infrastructure:

# Clone the repository
git clone https://github.com/yourusername/timetiles.git
cd timetiles
 
# Start with Docker
make up    # Starts PostgreSQL with PostGIS
make dev   # Starts the application

The application will be available at:

Manual Installation

For developers or advanced users who want full control:

  1. Clone and Install Dependencies

    git clone https://github.com/yourusername/timetiles.git
cd timetiles
pnpm install

  2. Database Setup

    # Install PostgreSQL 17+ with PostGIS extension
# Create database and user
createdb timetiles
psql timetiles -c "CREATE EXTENSION postgis;"

  3. Environment Configuration

    # Copy environment template
cp apps/web/.env.example apps/web/.env.local
 
# Edit with your database credentials
# DATABASE_URL=postgresql://user:password@localhost:5432/timetiles

  4. Run Migrations and Start

    cd apps/web
pnpm payload:migrate
cd ../..
pnpm dev

Production Deployment

For production deployments, additional considerations include:

  • Environment Variables: Proper secrets management
  • Database: Connection pooling and backups
  • File Storage: Configure cloud storage for uploads
  • Rate Limiting: API protection for public imports
  • Monitoring: Application and database performance
  • Security: HTTPS, CORS, and authentication settings

See the Developer Documentation for detailed production deployment guides.

Next Steps

Once installed, check out the User Guides to learn how to:

  • Import your first dataset
  • Create interactive timelines
  • Configure filters and visualizations
  • Share your chronicles

Need Help?

  • Technical Issues: Check the Developer Documentation
  • General Questions: See the FAQ
  • Community Support: Join our discussions on GitHub
Quick StartFAQ