Table of Contents

• Table of Contents
• (Super) Quick Start
• Documentation
• Open Source vs Cloud API vs Enterprise
• Quick Start with Docker Compose
• LLM Configuration
  • Using models.yaml (Recommended)
  • Using environment variables (Basic)
  • Common LLM API Providers
• Licensing
• Connect With Us

Open Source vs Cloud API vs Enterprise

---

The open-source release is ideal if you want transparency, local hosting, or to experiment with Chunkr’s pipeline.
For best performance, production reliability, and access to in-house models, we recommend the Chunkr Cloud API.
For high-security or regulated industries, our Enterprise edition offers on-prem or VPC deployments.

Quick Start with Docker Compose

1. Prerequisites:

   • Docker and Docker Compose
   • NVIDIA Container Toolkit (for GPU support, optional)

2. Clone the repo:

git clone https://github.com/lumina-ai-inc/chunkr
cd chunkr

3. Set up environment variables:

# Copy the example environment file
cp .env.example .env

# Configure your llm models
cp models.example.yaml models.yaml

For more information on how to set up LLMs, see here.

4. Start the services:

# For GPU deployment:
docker compose up -d

# For CPU-only deployment:
docker compose -f compose.yaml -f compose.cpu.yaml up -d

# For Mac ARM architecture (M1, M2, M3, etc.):
docker compose -f compose.yaml -f compose.cpu.yaml -f compose.mac.yaml up -d

5. Access the services:

   • Web UI: http://localhost:5173
   • API: http://localhost:8000

6. Stop the services when done:

# For GPU deployment:
docker compose down

# For CPU-only deployment:
docker compose -f compose.yaml -f compose.cpu.yaml down

# For Mac ARM architecture (M1, M2, M3, etc.):
docker compose -f compose.yaml -f compose.cpu.yaml -f compose.mac.yaml down

LLM Configuration

Chunkr supports two ways to configure LLMs:

1. models.yaml file: Advanced configuration for multiple LLMs with additional options
2. Environment variables: Simple configuration for a single LLM

Using models.yaml (Recommended)

For more flexible configuration with multiple models, default/fallback options, and rate limits:

1. Copy the example file to create your configuration:

cp models.example.yaml models.yaml

2. Edit the models.yaml file with your configuration. Example:

models:
  - id: gpt-4o
    model: gpt-4o
    provider_url: https://api.openai.com/v1/chat/completions
    api_key: "your_openai_api_key_here"
    default: true
    rate-limit: 200 # requests per minute - optional

Benefits of using models.yaml:

• Configure multiple LLM providers simultaneously
• Set default and fallback models
• Add distributed rate limits per model
• Reference models by ID in API requests (see docs for more info)

Read the models.example.yaml file for more information on the available options.

Using environment variables (Basic)

You can use any OpenAI API compatible endpoint by setting the following variables in your .env file:

LLM__KEY:
LLM__MODEL:
LLM__URL:

Common LLM API Providers

Below is a table of common LLM providers and their configuration details to get you started:

Licensing

The core of this project is dual-licensed:

1. GNU Affero General Public License v3.0 (AGPL-3.0)
2. Commercial License

To use Chunkr without complying with the AGPL-3.0 license terms you can contact us or visit our website.

Connect With Us

• 📧 Email: [email protected]
• 📅 Schedule a call: Book a 30-minute meeting
• 🌐 Visit our website: chunkr.ai