User Guide¶

Welcome to the Chicory User Guide! This comprehensive guide will help you master all aspects of Chicory, from basic task creation to advanced production deployment.

What You'll Learn¶

This guide is organized into several key sections to help you progressively build your knowledge:

Core Concepts¶

Workers

Understand worker lifecycle, scaling strategies, and deployment options.

Worker Guide
Configuration

Master Chicory's flexible configuration system and environment variables.

Configuration Guide

Infrastructure¶

Message Brokers

Choose and configure the right message broker for your use case.

Broker Overview
Result Backends

Store and retrieve task results with various backend options.

Backend Overview

By Use Case¶

Getting Started: Start with the Workers guide and Tutorial
Production Deployment: Review Configuration and broker setup (Redis or RabbitMQ)
Reliability: See Retry Policies for retry strategies and dead-letter queues
Performance: Check Workers for scaling and Configuration for optimization

By Component¶

Brokers¶

Broker Overview - Understanding message brokers
Redis Broker - Redis Streams setup and configuration
RabbitMQ Broker - RabbitMQ setup and advanced features

Backends¶

Backend Overview - Understanding result backends
Redis Backend - Redis backend for fast results
PostgreSQL Backend - Persistent storage with PostgreSQL

Getting Help¶

If you get stuck, here are some resources:

Examples: Check out our examples directory for working code
Tutorial: Follow the step-by-step tutorial for guided learning
API Reference: See the API documentation for detailed reference
GitHub Issues: Report bugs or request features on GitHub

Documentation Conventions¶

Throughout this guide, we use the following conventions:

Tips

Helpful suggestions and best practices appear in tip boxes like this.

Warnings

Important warnings about potential issues appear like this.

Information

Additional context and explanations appear in info boxes.

Examples

Code examples and practical demonstrations appear like this.

Code blocks show both synchronous and asynchronous examples where relevant:

# Async example (recommended)
async def my_task():
    await something()

# Sync example (also supported)
def my_task():
    something()

Environment variables are shown in uppercase:

CHICORY_BROKER_REDIS_HOST=localhost
CHICORY_WORKER_CONCURRENCY=16

Let's get started! Begin with the Workers guide to learn how to run background jobs, or check the Tutorial for a step-by-step introduction.