mirror of https://github.com/LearningCircuit/local-deep-research.git synced 2026-06-16 20:10:39 +03:00

Files

LearningCircuit d89c96353d remove: dedicated vLLM provider (use openai_endpoint instead)

The in-process vLLM provider (requiring torch+transformers+vllm ~10GB) is
obsolete — vLLM is universally run as a server and accessed via its
OpenAI-compatible API, which the openai_endpoint provider already handles.

Removes vllm from: config, pricing, rate limiting, hardware warnings,
frontend dropdowns, pyproject.toml optional deps, docs, default_settings.json,
golden master, benchmark template, and all related tests (37 files, -436 lines).

Keeps vLLM mentions in openai_endpoint context (labels, docs) since that's
the correct usage path.

2026-03-20 18:49:54 +01:00

1.7 KiB

Raw Blame History

Python Package (pip) Installation Guide

Note: For most users, Docker is preferred as it handles all dependencies automatically. pip install is best suited for developers or users who want to integrate LDR into existing Python projects.

Quick Install

# Step 1: Install the package
pip install local-deep-research

# Step 2: Setup SearXNG for best results
docker pull searxng/searxng
docker run -d -p 8080:8080 --name searxng searxng/searxng

# Step 3: Install Ollama from https://ollama.ai

# Step 4: Download a model
ollama pull gemma3:12b

# Step 5: Start the web interface
ldr-web

Open http://localhost:5000 after a few seconds.

SQLCipher (Database Encryption)

LDR uses SQLCipher for AES-256 encrypted databases. Pre-built sqlcipher3 wheels are available for Windows, macOS, and Linux — most users won't need to compile anything.

Full setup instructions: SQLCipher Install Guide
Skip encryption: If you don't need database encryption, set export LDR_BOOTSTRAP_ALLOW_UNENCRYPTED=true to use standard SQLite instead. API keys and data will be stored unencrypted.
Docker: Includes SQLCipher out of the box — no extra setup needed.

Optional Dependencies

MCP Server

For integration with Claude Desktop or Claude Code:

pip install "local-deep-research[mcp]"

Platform Notes

Windows PDF Export: PDF export requires Pango/Cairo system libraries. See the WeasyPrint installation guide for setup instructions.

Development from Source

For contributing or running from the latest code, see the Development Guide.

Back to Installation Overview

1.7 KiB Raw Blame History