No description
Find a file
2025-09-09 13:54:03 -04:00
.github/workflows speed up ci 2025-09-03 21:59:28 -04:00
documents adds support to load files in document folder at startup 2025-09-03 13:41:53 -04:00
flows Update ingestion flow JSON to enhance metadata handling and improve component configurations 2025-09-09 00:13:26 -03:00
frontend Merge branch 'main' into ingest-settings 2025-09-09 13:29:27 -04:00
keys empty keys directory 2025-09-02 17:12:21 -04:00
securityconfig os pw hash on startup 2025-09-03 10:33:20 -04:00
src merge better 2025-09-09 13:54:03 -04:00
.dockerignore Add environment and build file exclusions to .dockerignore 2025-09-08 18:06:18 -03:00
.DS_Store updated the default file loading task 2025-09-04 15:02:25 -04:00
.env.example Merge branch 'ingestion-flow' into langflow-ingestion-modes 2025-09-08 16:51:29 -04:00
.gitignore feat: Google Drive picker and enhancements 2025-09-03 14:11:32 -07:00
.python-version take 0 2025-07-10 22:36:45 -04:00
docker-compose-cpu.yml fix ingestion flow 2025-09-08 22:02:32 -04:00
docker-compose.yml fix ingestion flow 2025-09-08 22:02:32 -04:00
Dockerfile chown 2025-09-03 22:22:20 -04:00
Dockerfile.backend update to docker compose 2025-09-08 14:43:11 -04:00
Dockerfile.frontend change the parameter! 2025-09-08 15:42:20 -04:00
Dockerfile.langflow Create Dockerfile.langflow 2025-09-07 19:20:33 -04:00
Makefile Update Makefile for improved command execution and formatting 2025-09-08 18:57:33 -03:00
pyproject.toml 0.1.2 2025-09-09 00:19:09 -04:00
README.md change the parameter! 2025-09-08 15:42:20 -04:00
uv.lock Update uv.lock to reflect new package version and revision 2025-09-08 22:02:58 -03:00
warm_up_docling.py Fix import statement for logging configuration in warm_up_docling.py 2025-09-08 12:26:51 -03:00

OpenRAG

Ask DeepWiki

getting started

Set up your secrets:

cp .env.example .env

Populate the values in .env

Requirements:

Docker or podman with compose installed.

Run OpenRAG:

docker compose build

docker compose up

CPU only:

docker compose -f docker-compose-cpu.yml up

If you need to reset state:

docker compose up --build --force-recreate --remove-orphans

Configuration

OpenRAG uses environment variables for configuration. Copy .env.example to .env and populate with your values:

cp .env.example .env

Key Environment Variables

Required:

  • OPENAI_API_KEY: Your OpenAI API key
  • OPENSEARCH_PASSWORD: Password for OpenSearch admin user
  • LANGFLOW_SUPERUSER: Langflow admin username
  • LANGFLOW_SUPERUSER_PASSWORD: Langflow admin password
  • LANGFLOW_CHAT_FLOW_ID: ID of your Langflow chat flow
  • LANGFLOW_INGEST_FLOW_ID: ID of your Langflow ingestion flow

Ingestion Configuration:

  • DISABLE_INGEST_WITH_LANGFLOW: Disable Langflow ingestion pipeline (default: false)
    • false or unset: Uses Langflow pipeline (upload → ingest → delete)
    • true: Uses traditional OpenRAG processor for document ingestion

Optional:

  • LANGFLOW_PUBLIC_URL: Public URL for Langflow (default: http://localhost:7860)
  • GOOGLE_OAUTH_CLIENT_ID / GOOGLE_OAUTH_CLIENT_SECRET: For Google OAuth authentication
  • MICROSOFT_GRAPH_OAUTH_CLIENT_ID / MICROSOFT_GRAPH_OAUTH_CLIENT_SECRET: For Microsoft OAuth
  • WEBHOOK_BASE_URL: Base URL for webhook endpoints
  • AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY: For AWS integrations

See .env.example for a complete list with descriptions, or check the docker-compose.yml files.

For podman on mac you may have to increase your VM memory (podman stats should not show limit at only 2gb):

podman machine stop
podman machine rm
podman machine init --memory 8192   # example: 8 GB
podman machine start