Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ringee.io/llms.txt

Use this file to discover all available pages before exploring further.

This is the recommended way to run Ringee for production use. It handles all services (PostgreSQL, Redis, Frontend, Backend, Worker) in a single configuration.

​
Prerequisites

​
Installation

1

Clone the repository

git clone https://github.com/ringee-io/ringee-app.git
cd ringee
2

Create your environment file

cp .env.example .env
Open .env in your editor and fill in your API keys. At minimum, you need:See the full Configuration Reference for all available options.
3

Start all services

docker-compose -f docker-compose.app.yml up --build -d
This will start:
  • PostgreSQL database
  • Redis cache
  • Backend API server
  • Worker background processor
  • Admin Frontend on port 4200
  • Consumer Frontend on port 4201
4

Verify the installation

Check that all containers are running:
docker-compose -f docker-compose.app.yml ps
Then open:
When using docker-compose.app.yml, the values for DATABASE_URL, REDIS_HOST, REDIS_PORT, and REDIS_URL are automatically overridden to use Docker internal hostnames. You don’t need to set these manually.

​
Useful commands

# View logs
docker-compose -f docker-compose.app.yml logs -f

# Stop all services
docker-compose -f docker-compose.app.yml down

# Restart a specific service
docker-compose -f docker-compose.app.yml restart backend

# Rebuild after code changes
docker-compose -f docker-compose.app.yml up --build -d

​
Next steps

Configuration

Fine-tune your environment variables

Docker Config

Learn about Docker-specific configuration options