It's RAG in a box, as easy as it gets!
ragbox is a local retrieval-augmented generation (RAG) service that runs in a single Docker container. It indexes the files in a folder and lets AI agents search them through the Model Context Protocol (MCP).
- Scans a folder that you mount into the container as read-only.
- Extracts the text from each supported file, splits it into chunks, and creates an embedding for each chunk. Embeddings are created by an external provider, such as Ollama or any OpenAI-compatible API.
- Stores the chunks and embeddings in PGlite , an embedded PostgreSQL database with the pgvector extension. No separate database is required.
- Watches the folder and re-indexes files that are added, changed, or deleted. After a file changes, ragbox waits for a cool-down period (10 seconds by default) before it re-indexes the file.
- Runs an MCP server over HTTP with one tool,
search. The tool combines vector search with keyword search. - Serves a web page where you can monitor indexing, see errors, run test searches, and change settings.
| Type | Extensions |
|---|---|
| Documents | .pdf ,.docx ,.docm ,.dotx ,.pptx ,.pptm ,.potx ,.xlsx ,.xlsm |
| Text and markup | .md ,.markdown ,.mdx ,.txt ,.text ,.log ,.rst ,.html ,.htm ,.xhtml |
| Data | .csv ,.tsv ,.json ,.jsonc ,.json5 ,.hujson ,.geojson ,.webmanifest ,.yaml ,.yml ,.xml ,.xsd ,.xsl ,.xslt ,.svg ,.plist ,.csproj ,.pom ,.ipynb |
| Source code | .py ,.c ,.h ,.cpp ,.cc ,.hpp ,.js ,.jsx ,.mjs ,.cjs ,.ts ,.tsx ,.mts ,.cts ,.java ,.cs ,.go ,.rs ,.kt ,.kts ,.swift ,.scala ,.rb ,.php ,.lua ,.dart ,.tf ,.cue ,.rego ,.bzl ,.star ,.proto ,.sql ,.sh ,.bash ,.zsh ,.fish ,.ps1 ,.bat ,.cmd ,.jq |
| Files without an extension | Dockerfile ,Containerfile ,Makefile ,Tiltfile ,BUILD ,BUILD.bazel |
| Images | .png ,.jpg ,.jpeg ,.jpe ,.jfif ,.gif ,.webp |
| Audio | .wav ,.wave |
MetaTrader files (.mq4, .mqh) are also supported but are disabled by
default. You can enable or disable any file type on the Settings page.
PDF files must contain a text layer. ragbox doesn't run OCR on scanned documents.
Before you begin, install Docker. Ollama is optional: if it isn't installed, ragbox can run Ollama in a container.
The setup script asks a few questions, starts ragbox, and shows how to connect an MCP client. It works on macOS, Linux, and Windows Subsystem for Linux (WSL).
Clone the repository:
git clone https://github.com/ferraridavide/ragbox.git
cd ragbox
Run the setup script:
./run.sh
Follow the wizard. It asks which folder to index, starts ragbox, and returns the MCP endpoint to add to your client.
On macOS, Docker containers can't use the GPU, so Ollama in a container is much slower than a native installation. For faster indexing on a Mac, install Ollama before you run the script.
To start ragbox without the setup script, choose the Compose file that fits
your setup. Replace /path/to/your/documents with the folder that you want
to index.
If Ollama is installed on your computer, download the embedding model and start ragbox:
ollama pull embeddinggemma-2
RAGBOX_DOCS=/path/to/your/documents docker compose up -d --build
If Ollama isn't installed, start ragbox together with an Ollama container. The container downloads embeddinggemma-2 on first start:
RAGBOX_DOCS=/path/to/your/documents docker compose -f docker-compose.ollama.yml up -d --build
To use an NVIDIA GPU on Linux, uncomment the deploy section indocker-compose.ollama.yml .
Open http://localhost:8080 to see the indexing progress. To use a different
port, set RAGBOX_HOST_PORT, for example RAGBOX_HOST_PORT=9090.
embeddinggemma-2 also embeds images and audio. For details, see
Images and audio. To use a different model, change
RAGBOX_EMBEDDING_MODEL in the Compose file.
The MCP endpoint is http://localhost:8080/mcp. It uses the Streamable HTTP
transport.
To add ragbox to Claude Code, run the following command:
claude mcp add --transport http ragbox http://localhost:8080/mcp
For clients that use a JSON configuration file, add the following entry:
{
"mcpServers": {
"ragbox": { "type": "http", "url": "http://localhost:8080/mcp" }
}
}
The search tool accepts the following arguments:
| Argument | Required | Description |
|---|---|---|
query |
Yes | The text to search for. |
limit |
No | The maximum number of results, from 1 to 50. The default is 8. |
path_prefix |
No | Searches only the files in this folder, for example projects/acme/ . |
You can change all settings on the Settings page of the web interface.
To set initial values, use environment variables in docker-compose.yml.
Values that you save in the web interface take precedence over environment
variables.
| Variable | Default | Description |
|---|---|---|
RAGBOX_EMBEDDING_PROVIDER |
ollama |
ollama oropenai . Useopenai for any OpenAI-compatible API. |
RAGBOX_EMBEDDING_URL |
http://host.docker.internal:11434 |
The URL of the embedding provider. For openai , include the API version, for examplehttps://api.openai.com/v1 . |
RAGBOX_EMBEDDING_MODEL |
embeddinggemma |
The embedding model. |
RAGBOX_EMBEDDING_API_KEY |
None | The API key for the embedding provider. |
RAGBOX_COOLDOWN_SECONDS |
10 |
The number of seconds to wait after a file changes before ragbox re-indexes it. |
RAGBOX_MCP_TOKEN |
None | If set, MCP clients must send the header Authorization: Bearer <token> . |
Every other setting on the Settings page can be set in the same way. The
variable name is RAGBOX_ followed by the setting name in upper snake case.
For example, chunkSize becomes RAGBOX_CHUNK_SIZE.
If you change the embedding model, ragbox rebuilds the index.
- The web interface doesn't have authentication. By default,
docker-compose.ymlmakes ragbox available only on127.0.0.1. - Run only one ragbox container for each data volume.
- On Linux, the container runs as user ID 1000. That user must be able to read the mounted folder.
- On Linux, a native Ollama installation listens only on
127.0.0.1by default, so the ragbox container can't reach it. SetOLLAMA_HOST=0.0.0.0for the Ollama service, or usedocker-compose.ollama.yml.
To run ragbox without Docker, you need Node.js 22 or later.
npm install
RAGBOX_DOCS_DIR=./docs RAGBOX_DATA_DIR=./data RAGBOX_EMBEDDING_URL=http://localhost:11434 npm run dev
npm test
ragbox is licensed under the MIT License. Parts of the file parsing and chunking code are adapted from knowledge-rag, which is also licensed under the MIT License. For details, see LICENSE.