GitHub Get Started

Getting Started

Quick start guide for installing and setting up GOTRS.

Getting Started with GOTRS

Get GOTRS up and running quickly with Docker or Podman.

Prerequisites

  • Docker or Podman
  • Docker Compose or Podman Compose
  • 2GB RAM minimum
  • PostgreSQL 15+ (included in compose)

Quick Start

Full installation guide coming soon. GOTRS is currently in active development.

Development Preview

# Clone the repository
git clone https://github.com/gotrs-io/gotrs-ce.git
cd gotrs-ce

# Start with Podman (preferred)
make up

# Or with Docker
DOCKER_CMD=docker make up

What’s Included

  • PostgreSQL: Primary database
  • Valkey: Caching and sessions
  • Backend: Go API server with hot reload
  • Frontend: React application with HMR
  • Nginx: Reverse proxy
  • MailHog: Email testing (development)

Next Steps

  1. Complete Installation: Follow the full setup guide
  2. Initial Configuration: Configure your GOTRS instance
  3. User Setup: Create admin users and configure authentication
  4. Email Setup: Configure SMTP for production

Need Help?

Check out our support page for community help and professional services.