RiceBallRiceBall
Guide
Deployment
  • English
  • 简体中文
GitHub
Guide
Deployment
  • English
  • 简体中文
GitHub
  • Guide

    • Introduction
    • Getting Started
    • Architecture Overview
    • Configuration Guide

Configuration Guide

RiceBall uses environment variables and configuration files for management.

Environment Variables

RiceBall supports configuration via .env files or directly setting system environment variables. System environment variables take precedence over .env files. This means you can inject environment variables directly in Docker containers or production environments to override default configurations.

Backend Configuration (backend/.env)

Copy backend/.env.example to backend/.env and modify the following values:

VariableDescriptionDefault / Example
ENVIRONMENTRuntime environmentdevelopment or production
LOG_LEVELLogging verbosityDEBUG, INFO, WARNING, ERROR
APP_NAMEName of the projectRiceBall
DATABASE_URLPostgreSQL connection stringpostgresql+asyncpg://user:pass@host:5432/db
SECRET_KEYSecret key for encryption and JWTChange this in production!
EXTERNAL_URLPublic URL of the backend APIhttp://localhost:8000
FRONTEND_URLPublic URL of the frontendhttp://localhost:3000

Email Settings

Used for sending verification emails and notifications.

VariableDescription
MAIL_SERVERSMTP server hostname (e.g., smtp.gmail.com)
MAIL_PORTSMTP port (e.g., 587)
MAIL_USERNAMESMTP username
MAIL_PASSWORDSMTP password
MAIL_FROMSender email address
MAIL_STARTTLSEnable STARTTLS (true/false)
MAIL_SSL_TLSEnable SSL/TLS (true/false)

File Storage (S3 Compatible)

RiceBall uses S3-compatible storage (like MinIO or AWS S3) for files.

VariableDescription
S3_ENDPOINT_URLS3 API endpoint URL
S3_ACCESS_KEY_IDAccess Key
S3_SECRET_ACCESS_KEYSecret Key
S3_BUCKET_NAMEBucket name for file storage
S3_REGIONAWS Region (optional for MinIO)

Vector Store (ChromaDB)

Settings for the vector database used for RAG.

VariableDescriptionDefault
CHROMA_SERVER_HOSTHostname of ChromaDB serverchromadb
CHROMA_SERVER_PORTPort of ChromaDB server8000

Frontend Configuration

Frontend configuration is primarily handled via build-time environment variables or Docker environment variables.

VariableDescriptionDefault
API_BASE_URLURL of the backend API (for proxying)http://localhost:8000/api
APP_NAMEDisplay name of the applicationRiceBall

System Configuration

System-level configurations (like "Allow Registration", "Default Model") are stored in the database and can be modified via the Admin Dashboard in the web interface.

Edit this page
Last Updated: 12/31/25, 7:58 AM
Contributors: Rafi
Prev
Architecture Overview