Skip to content

Getting Started

Welcome to Champa Intelligence! This section provides everything you need to get the platform installed, configured, and running in your environment.

Whether you prefer a quick setup for evaluation or a detailed guide for a production deployment, these documents will walk you through the process.

For the best experience, we recommend following these steps in order:

  1. Review the Prerequisites to ensure your environment is ready.
  2. Follow the Quick Start Guide for the fastest way to get a running instance using Docker.
  3. Refer to the Installation Guide for more detailed, production-focused instructions.
  4. Use the Configuration Guide and Environment Variables Reference to customize the platform for your specific Camunda setup.

  • Quick Start Guide

    Get a fully functional instance up and running in under 15 minutes using our Docker Compose setup. Perfect for evaluation and development.

  • Installation Guide

    Follow detailed, step-by-step instructions for both Docker-based production deployments and manual installations.

  • Configuration Guide

    Dive deep into the config.py and .env files to fine-tune application behavior, from database connections to AI settings.

  • Environment Variables Reference

    A complete reference for all environment variables used to configure and secure the application, with examples for different environments.

Prerequisites

Before you begin, please ensure you have the following:

Technical Requirements

  • Docker & Docker Compose (Recommended): The easiest and most reliable way to run the application.
  • Manual Installation: If not using Docker, you will need:
    • Python 3.10+
    • Node.js 16+ and npm
    • PostgreSQL 14+
    • Redis 6+
  • Git: For cloning the application repository.

System Access

  • Camunda Database Access: Read-only credentials for your Camunda 7 PostgreSQL database.
  • Google Gemini API Key: Required to enable the AI-Powered Analysis features. You can obtain a key from the Google AI Studio.

Read-Only is Sufficient

Champa Intelligence only requires read-only access to your Replica of Camunda database, ensuring it can never interfere with your running processes. The application uses its own separate database for storing user accounts and session data.

Next Steps

Once you have a running instance, you'll be ready to: