Guide · Open source
How to use localGPT: install with Docker and chat with your documents
Updated · written with AI from the project's own documentation and checked against our catalogue data
localGPT is an open-source document question-answering app. You load your own files, ask questions in plain English, and get answers grounded in those files, with models run through Ollama on your own computer. This guide walks through the Docker setup, what hardware you need, and how the main features work, so you can finish with a running local instance and an index of your documents.
Quick start
- 1Check prerequisites. Confirm Python 3.10+, Node.js 20+ with npm, Docker and at least 8GB of RAM are available. Ollama must be installed.
- 2Clone the repository. Run git clone on the PromtEngineer/localGPT repository and change into the localGPT folder.
- 3Install and start Ollama. Install Ollama, pull the qwen3.5:9b and qwen3.5:4b models, then run ollama serve.
- 4Start the Docker deployment. Run ./start-docker.sh in a new terminal to launch the containers.
- 5Open the web interface. Go to http://localhost:3000 in your browser.
- 6Create an index and load documents. Add your PDF, DOCX, HTML, Markdown or TXT files to a new index using the web UI.
- 7Ask questions. Start a chat session and ask questions in plain English, then check the attributed source chunks.
What you need before you install localGPT
The README lists Python 3.10+ (3.11 recommended), Node.js 20+ and npm, Ollama, and Docker as optional for containerized deployment. Ollama is required for both deployment approaches.
For hardware, the README recommends 8GB+ RAM, with 16GB+ recommended for more comfort.
- Python 3.10+ (3.11 recommended, as the Docker images use python:3.11-slim)
- Node.js 20+ and npm
- Ollama (required for both approaches)
- Docker (optional, for containerized deployment)
- 8GB+ RAM (16GB+ recommended)
Install localGPT with Docker
Clone the repository, then install Ollama on your host and pull the two models the README names. The README recommends installing Ollama locally even when using Docker.
Start Ollama, then launch the Docker deployment in a new terminal and open the web interface at localhost port 3000.
- If you would rather not install Ollama on the host, run ./start-docker.sh container and pull the models inside the container with docker compose --profile with-ollama exec ollama ollama pull qwen3.5:9b.
- Running ./start-docker.sh with no argument uses local Ollama. If nothing listens on port 11434, it offers to switch to the containerized Ollama. Add -y or set NONINTERACTIVE=1 to accept that fallback without a prompt.
git clone https://github.com/PromtEngineer/localGPT.git
cd localGPT
curl -fsSL https://ollama.ai/install.sh | sh
ollama pull qwen3.5:9b
ollama pull qwen3.5:4b
ollama serve
./start-docker.sh
open http://localhost:3000Manage the Docker deployment
Once containers are running, you can check their status, read logs and stop the stack using the commands the README provides.
- Check container status: docker compose ps
- View logs: docker compose logs -f
- Stop containers: ./start-docker.sh stop
Run localGPT directly with Python (developer path)
The README lists a direct development option for people who want to work on the code. It installs Python dependencies from requirements.txt and Node.js dependencies with npm, then starts the system with run_system.py.
The key Python dependencies named in the README include torch, transformers, lancedb (vector store and full-text search), rerankers (cross-encoder reranking) and docling (document parsing).
- Install Python dependencies: pip install -r requirements.txt
- Install Node.js dependencies: npm install
- Start the system: python run_system.py
pip install -r requirements.txt
npm install
ollama pull qwen3.5:9b
ollama pull qwen3.5:4b
ollama serve
python run_system.pyLoad documents and ask questions
localGPT parses PDF, DOCX, HTML/HTM, Markdown and TXT files using Docling. You build an index from your documents, then chat against it. Answers come back with the chunks they were grounded in, so you can check the source passages.
Each query can be routed either to retrieval over your documents or to a direct LLM answer, and complex questions are split into sub-questions before retrieval.
- Supported formats: PDF, DOCX, HTML/HTM, Markdown, TXT
- PDFs with no text layer are re-run through Docling's OCR pipeline
- Source attribution shows the chunks behind each answer
- Live progress streams retrieval, reranking and synthesis stages into the chat
Tune settings and use the API
Settings such as models, chunk size, retrieval mode and toggles can be changed per request. The main defaults live in rag_system/main.py and can be overridden by environment variable. The README says the RAG core exposes a REST gateway on port 8000 and the RAG API on port 8001.
Optional features such as Late Chunking, Answer Verification and multi-vector retrieval are off by default and can be enabled through config. For example, the README names the retrieval.latechunk.enabled flag and the verification.enabled setting.
- Default configuration: rag_system/main.py
- REST gateway: port 8000
- RAG API: port 8001
- Late Chunking flag: retrieval.latechunk.enabled (off by default)
- Answer Verification setting: verification.enabled (off by default)
What people use it for
- Asking questions about private PDFs or contracts without uploading them to a cloud service
- Summarising and searching across a folder of Markdown or text notes
- Building a local RAG backend that calls the REST API from your own application
- Experimenting with retrieval settings such as chunk size and retrieval mode through config
Frequently asked questions
Is localGPT free to use?
localGPT is released under the MIT licence, as listed on its repository. The README does not describe any paid tier, and the models are run through Ollama on your own computer.
What hardware do I need to run localGPT?
The README recommends 8GB+ RAM, with 16GB+ recommended for comfort. You also need Ollama installed, and Docker is optional.
Does localGPT send my documents to the internet?
The README says no data leaves your device and describes the tool as 100% private. Models run through Ollama on your own computer.
How do I install localGPT with Docker?
Clone the repository, install and start Ollama, pull the qwen3.5:9b and qwen3.5:4b models, then run ./start-docker.sh and open http://localhost:3000.
Can I use localGPT without installing Ollama on my computer?
Yes. The README describes running Ollama as a container with ./start-docker.sh container, then pulling the models inside that container with docker compose.
How does localGPT compare to PrivateGPT, AnythingLLM or Open WebUI?
This page does not include a benchmark comparison. The comparable projects are PrivateGPT, AnythingLLM and Open WebUI, and you should test each against your own documents and hardware before choosing.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
localGPT suits people who want to query private documents on their own machine and developers who want a local RAG backend with a REST API. It is a poor fit for users with limited hardware, anyone wanting a one-click install, or teams needing hosted multi-user deployment.
Install options & downloads