Installation
Get Rephole running on your machine in under 5 minutes.
Prerequisites
Before installing Rephole, ensure you have:
- Docker & Docker Compose - For containerized deployment
- Git - To clone the repository
- pnpm - Package manager (recommended)
- An OpenAI API key - For generating embeddings
Installation
Docker Compose
The fastest way to get started:
# Clone the repository
git clone https://github.com/twodHQ/rephole.git
cd rephole
# Configure your environment
cp .env.example .env
# Edit .env and add your OPENAI_API_KEY
# Start Rephole services (Redis, PostgreSQL, ChromaDB)
docker-compose up -d
# Install dependencies
pnpm install
# Start API server and Worker
pnpm start:all
Rephole is now running:
- API Server: http://localhost:3000
- Worker: Running in background on port 3002
Verify Installation
Check that all services are running:
# Verify API is responding
curl http://localhost:3000/health
Expected response:
{
"status": "ok"
}
What's Running?
After installation, you'll have the following services:
| Service | Port | Description |
|---|---|---|
| API Server | 3000 | REST API endpoints |
| Worker | 3002 | Background job processor |
| PostgreSQL | 5432 | Metadata storage |
| Redis | 6379 | Job queue |
| ChromaDB | 8000 | Vector database |
Next Steps
Once installed, proceed to Your First Query to ingest and search your first repository.