Repository navigation
feat: Windows installer with a bundled language model, plus credits - #7
Merged
Merged
Conversation
A bundled engine loads its models from models_dir/<org>--<name> under the same model names, so the index fingerprint and existing indexes stay valid. --llm-url points the engine at the llama-server the app starts.
installer/build.py stages a self-contained Open RAG and runs Inno Setup: the published app, a uv-managed CPython 3.12 with the engine and its locked dependencies (CPU torch), the embedding and reranker models from the Hugging Face cache, the Qwen3 GGUF from Ollama (digest-checked) and llama.cpp's llama-server (pinned b12052, sha256-checked). The setup installs per user, keeps the library on uninstall and comes in parts below GitHub's 2 GiB limit. The app starts the bundled llama-server on a free loopback port with its own key and points the engine at it with --llm-url. ChildHost replaces EngineHost and runs both processes, waiting on ORE_READY or a /health probe. Logs rotate at 5 MB. installer/smoke_test.py checks a stage or an installed app end to end. The window also opens the credits' GitHub and LinkedIn links, and only those (ExternalLinks).
The sidebar says who developed Open RAG and opens a Credits sheet with both authors' GitHub and LinkedIn and the source code. Links open in the default browser through the window, which accepts only the links on its own list; a test checks the sheet's links against it.
3 of 4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #6 (merge that first).
What this adds
A Windows installer that needs nothing else (
installer/)uv run python installer/build.pystages a self-contained Open RAG and runs Inno Setup. The stage contains:win-x64llama-server, CPU build b12052, checked against its sha256The setup:
%LOCALAPPDATA%\Programs\Open RAG%LOCALAPPDATA%\OpenRag) on uninstall and updateIt comes as
OpenRag-Setup.exeplus two.binparts, each under GitHub's 2 GiB limit per release file, because the model alone is 2.5 GB. That's about 3.2 GB to download and 4.8 GB installed.The app runs the bundled model
When
engine/llm/is present, the app:llama-serveron a free loopback port with a random key, passed throughLLAMA_API_KEYso it never shows on a command line.--llm-url.ChildHostreplacesEngineHostand runs both processes. It waits either forORE_READYor for a/healthprobe, and rotates logs at 5 MB.Credits
The sidebar says "Developed by Wadi & Ghassen" and opens a Credits sheet with our GitHub and LinkedIn links and the source code. The window opens only links on its own list (
ExternalLinks), and a test checks that the sheet's links match that list.Fix for #6
The Python
.gitignoretemplate ignored everylib/folder, sodesktop/web/src/lib(the engine client, the bridge, chat storage and the mock) was never committed. I pushed that fix to #6's branch, and it's merged here.Test plan
dotnet test: 69 passedtsc -b, 15 tests passedpytestandruffpassinstaller/smoke_test.pyon the stage passes with model downloads blocked:llama-serverrefuses requests without the keyOpenRag.exestartsllama-serverand the engine, and an existing library loads without re-indexingOpenRag-Setup.exeon a second Windows machine, ask a question offline, then uninstall