LocalRecall

Overview

A lightweight, no-frills RESTful API designed for managing knowledge bases and files stored in vector databases—no GPU, internet, or cloud services required!

Requirements

        Works best with a separate LocalAI instance or OpenAI-compatible API for AI capabilities.


        Requires a Postgres database for storing vector embeddings and metadata.

Runtime arguments

Web UI: http://[IP]:[PORT:8080]/
Network: bridge
Privileged: false

Template configuration

Web UI PortPorttcp

Container Port: 8080

Target: 8080
Default: 8080
Value: 8080

Embedding ModelVariable

Embedding model.

Target: EMBEDDING_MODEL
Default: granite-embedding-107m-multilingual
Value: granite-embedding-107m-multilingual

OpenAI API - Base URLVariable

Base URL for the OpenAI-compatible API. If using LocalAI on the same machine, set to http://IP_ADDRESS:8080

Target: OPENAI_BASE_URL
Default: http://IP_ADDRESS:8080
Value: http://IP_ADDRESS:8080

OpenAI API - KeyVariable

API key for the OpenAI-compatible API.

Target: OPENAI_API_KEY

Database - URLVariable

Postgres database connection URL.

Target: DATABASE_URL
Default: postgresql://USERNAME:PASSWORD@IP_ADDRESS:5432/localrecall?sslmode=disable
Value: postgresql://USERNAME:PASSWORD@IP_ADDRESS:5432/localrecall?sslmode=disable

Internal Collections Database PathVariable

Internal path to the collections database. Not recommended to change.

Target: COLLECTION_DB_PATH
Default: /db
Value: /db

Internal Assets PathVariable

Internal path to the assets directory. Not recommended to change.

Target: FILE_ASSETS
Default: /assets
Value: /assets

Database PathPath

Path to the database directory for LocalRecall

Target: /db
Default: /mnt/user/appdata/local_recall/db
Value: /mnt/user/appdata/local_recall/db

Assets PathPath

Path to the assets directory for LocalRecall

Target: /assets
Default: /mnt/user/appdata/local_recall/assets
Value: /mnt/user/appdata/local_recall/assets

Vector EngineVariable

Vector database engine to use. Currently only 'postgres' is supported.

Target: VECTOR_ENGINE
Default: postgres
Value: postgres

Hybrid Search - BM25 WeightVariable

Weight for BM25 in hybrid search (0.0 to 1.0).

Target: HYBRID_SEARCH_BM25_WEIGHT
Default: 0.5
Value: 0.5

Hybrid Search - Vector WeightVariable

Weight for vector search in hybrid search (0.0 to 1.0).

Target: HYBRID_SEARCH_VECTOR_WEIGHT
Default: 0.5
Value: 0.5

Links

Template Support Quay Project

Details

Repository

quay.io/mudler/localrecall:latest

Registry

https://registry.hub.docker.com/r/quay.io/mudler/localrecall

Last Updated2026-06-02

First Seen2025-07-16

Run LocalRecall on Unraid.

LocalRecall is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS