Skip to content

Getting Started

The fastest way to use TrustRAG — download and run.

1. Download

Go to GitHub Releases and download the installer for your platform:

PlatformFileNotes
WindowsTrustRAG-Setup-Windows-x64.exeOne-click installer
Windowstrustrag-windows-x64-portable.zipNo install needed
macOStrustrag-macos.tar.gzUnsigned — see note below
Linuxtrustrag-linux-x64.tar.gzExtract and run
Androidapp-release.apkEnable "Install from unknown sources"

2. Install and Launch

  • Windows: Run the .exe installer, or extract the portable zip
  • macOS: Extract and move to Applications. Right-click → Open (unsigned app)
  • Linux: Extract and run the trustrag binary

3. Start Using

  1. The app creates a local user automatically on first launch
  2. Create a workspace
  3. Configure an LLM provider (OpenAI-compatible, Ollama, etc.)
  4. Upload documents (PDF, DOCX, Markdown, TXT)
  5. Start chatting with your documents

macOS Users

TrustRAG is not signed by Apple. On first launch, right-click the app and select "Open", or go to System Settings → Privacy & Security → Allow.

Windows Users

Windows SmartScreen may show a warning on first launch. Click More infoRun anyway.

Server Mode (Docker Compose)

For teams needing PostgreSQL vector search, Redis, and MinIO:

bash
# Clone the repository
git clone https://github.com/XimilalaXiang/TrustRAG.git
cd TrustRAG

# Copy environment template
cp .env.example .env

# Build Flutter web client
cd apps/client
flutter pub get
flutter build web --dart-define=API_BASE_URL=/api
cd ../..

# Start all services
cd infra
docker compose up --build

Open http://localhost to access the web app.

Released under the Apache 2.0 License.