Getting Started
Welcome to the Syncturtle documentation!
This Getting Started section will help you setup your first Syncturtle instance.
Why self-host Syncturtle
Deployment methods
Choose the deployment method that best fits your infrastructure
Docker Compose
Quick setup with minimal configuration
Kubernetes
Production-ready deployment for clusters
Bare Metal
Install directly on a server or VM
System requirements
- CPU: 2 cores
- RAM: 4GB (8GB recommended for production)
- OS: Linux (Ubuntu 20.04+, Debian 10+, CentOS 8+), macOS, or Windows with WSL2
Configuration and governance
Once deployed, configure your Syncturtle instance to match your needs:
Instance Admin and God Mode
Configure instance-wide settings, manage users, and access God Mode for advanced administrative controls.
Authentication
Set up SSO, OAuth, LDAP, or other authentication methods. Support for Google, Github, GitLab, and custom providers.
Email and communication
Configure SMTP for email notifications, invitations, and alerts. Integrate with SendGrid, AWS SES, or your own mail server.
External services
Connect to managed databases (PostgreSQL, Redis) and cloud storage (S3, MinIO, GCS) for scalable, production-ready deployments.