Skip to content

Prerequisites

RequirementMinimumRecommended
Docker Engine20.10+27.x
Docker Compose2.0+2.30+
RAM4 GB8 GB
Disk Space5 GB20 GB
OSLinux, macOS, Windows (WSL2)Linux (amd64)

FluidRAG requires a running FalkorDB instance for knowledge graph storage and traversal. FalkorDB is not bundled in the Docker Compose stack — you must provide your own instance.

You will need:

  • Host and port of your FalkorDB instance (e.g., 10.0.70.120:6397)
  • Password if authentication is enabled
  • A knowledge graph name (e.g., my_kg_v1)

FalkorDB runs on port 6379 by default. If you run FalkorDB in Docker, map it to a different port to avoid conflicts with the bundled Redis container.

Terminal window
# Example: running FalkorDB separately
docker run -d --name falkordb \
-p 6397:6379 \
falkordb/falkordb:latest

FluidRAG supports multiple LLM providers. You need at least one API key:

ProviderAPI KeyUsed For
OpenAIsk-...Embeddings, entity extraction, synthesis, agent execution
Anthropicsk-ant-...Agent execution, synthesis
GoogleAIza...Agent execution, synthesis, embeddings
OpenAI-CompatibleVariesCustom endpoints (Ollama, vLLM, etc.)

Other supported providers: Groq, OpenRouter, DeepSeek, Fireworks, AWS Bedrock.

API keys are configured through the Admin UI after deployment — do not put them in your .env file.

If you want to run FluidRAG outside Docker for development:

  • Python 3.11+ (3.12 recommended)
  • Dependencies are managed via uv (see pyproject.toml)

FluidRAG containers need outbound access to:

DestinationPurpose
Your FalkorDB hostGraph database queries
LLM provider APIs (e.g., api.openai.com)Embeddings, chat completions
etcd (bundled)Configuration management (internal)
Redis (bundled)Job queue, caching (internal)

No inbound ports need to be exposed beyond those mapped in docker-compose.yml.