Self-hosting Flexprice

Learn how to set up and run Flexprice on your own infrastructure

Prerequisites

Before you begin, make sure you have the following installed:

Golang

Docker and Docker Compose

One of these supported platforms:

• Linux-based environment
• macOS (Darwin)
• WSL under Windows

Quick Setup with Docker Compose

The easiest way to get started is using our Docker Compose setup:

# Clone the repository
git clone https://github.com/flexprice/flexprice
cd flexprice

# Set up the complete development environment
make dev-setup

This single command takes care of everything you need to get started:

1. Starting all required infrastructure (PostgreSQL, Kafka, ClickHouse, Temporal)
2. Building the Flexprice application image
3. Running database migrations and initializing Kafka
4. Starting all Flexprice services (API, Consumer, Worker)

Accessing Services

Once setup is complete, you can access:

Flexprice API

http://localhost:8080

Temporal UI

http://localhost:8088

Kafka UI

http://localhost:8084

ClickHouse UI

http://localhost:8123

Useful Commands

Here are some common commands you might need during development:

Restart Flexprice Services

make restart-flexprice

Stop All Services

make down

Clean Start

make clean-start

Build Flexprice Image

make build-image

Start Only Flexprice Services

make start-flexprice

Running Without Docker

If you prefer to run the application directly:

# Start the required infrastructure
docker compose up -d postgres kafka clickhouse temporal temporal-ui

# Run the application locally
go run cmd/server/main.go

Connection Details

Use these credentials to connect to the various services:

PostgreSQL

• Host: localhost
• Port: 5432
• Database: flexprice
• Username: flexprice
• Password: flexprice123

ClickHouse

• Host: localhost
• Port: 9000
• Database: flexprice
• Username: flexprice
• Password: flexprice123

Kafka

• Bootstrap Server: localhost:29092
• UI: http://localhost:8084 (with profile ‘dev’)

API Documentation

Flexprice provides comprehensive API documentation in OpenAPI 3.0 format.

Setting up Postman

1. Open Postman
2. Click on “Import” in the top left
3. Select “Import File”
4. Choose docs/swagger/swagger-3-0.json
5. Click “Import”
6. Create a new environment for local development:
   • Name: Local
   • Variable: baseUrl
   • Value: http://localhost:8080/v1
   • Variable: apiKey
   • Value: 0cc505d7b917e0b1f25ccbea029dd43f4002edfea46b7f941f281911246768fe

Troubleshooting

If you encounter issues during setup or operation, try these troubleshooting steps:

Docker Issues

1. Ensure Docker is running properly:

docker info

2. Check the status of all containers:

docker compose ps

3. View logs for a specific service:

docker compose logs [service_name]

Database Connection Issues

1. Check database logs:

docker compose logs postgres
docker compose logs clickhouse

2. Verify the database is running:

docker compose ps postgres
docker compose ps clickhouse

Kafka Issues

1. Verify Kafka is running:

docker compose logs kafka

2. Check topic list:

docker compose exec kafka kafka-topics --bootstrap-server kafka:9092 --list

3. View Kafka UI at http://localhost:8084

Need Help?

If you’re still experiencing issues after trying the troubleshooting steps, please:

• Check our GitHub Issues for similar problems
• Join our Slack community for real-time support
• Contact us at [e-mail]

Additional Resources

Contribution Guidelines

Learn how to contribute to Flexprice

API Documentation

Explore our API documentation

Code of Conduct

Our community guidelines

Flexprice Website

Visit our official website