UniDocVerse Help Guide
Your private, local-first AI document intelligence platform — from installation to advanced workflows, everything you need to get started and go deeper.
1What is UniDocVerse?
UniDocVerse is a private document intelligence platform that lets you upload, analyze, and ask questions about any document — entirely on your own machine. No document ever leaves your device. All AI processing runs on phi3:mini via Ollama, a compact local language model.
Who It's For
| Role | How they use UniDocVerse |
|---|---|
| Insurance professionals | Analyze policies, COIs, renewals, loss runs, commission statements |
| Legal teams | Review contracts, NDAs, lease agreements, regulatory filings |
| Healthcare admins | Process medical records, lab reports, intake forms |
| Finance teams | Parse bank statements, invoices, tax returns, expense reports |
| HR professionals | Screen resumes, manage handbooks, review performance docs |
| Real estate | Handle appraisals, title deeds, disclosures |
| Supply chain | Track purchase orders, bills of lading, shipping manifests |
| Administrators | Configure the platform, manage users, enable industry modules |
2Installation
Option A — macOS Desktop (DMG)
The DMG is a fully self-contained installer. It bundles PostgreSQL, Ollama, phi3:mini, and the FastAPI backend — no internet connection required after installation.
- Download
unidocverse_0.1.0_universal.dmgfrom the downloads page. - Open the DMG and drag UniDocVerse.app to your Applications folder.
- Double-click UniDocVerse in Applications to launch.
- On first launch macOS may show a security prompt — click Open.
- The app starts PostgreSQL, Ollama, and the backend in the background (≈15 seconds).
- The web interface loads in the app window. You're ready.
Gatekeeper warning: If macOS shows "cannot be opened because the developer cannot be verified", go to System Settings → Privacy & Security and click Open Anyway. The app is signed with a Developer ID certificate.
What happens on first launch
Option B — Docker (Server / Team Mode)
Run UniDocVerse as a multi-container stack for shared team access or server deployment.
# Pull and start all services
docker compose up -d
# Or pull the pre-built all-in-one image
docker pull bommavj/unidocverse:latest
docker run -p 80:80 bommavj/unidocverse:latest
Open http://localhost in your browser. Services included:
| Service | Port | Role |
|---|---|---|
| PostgreSQL + pgvector | 54321 | Primary database with vector search |
| Flyway | — | Runs schema migrations V1–V39 on startup |
| Ollama | 11434 | LLM server hosting phi3:mini |
| FastAPI backend | 8000 | API server and document processing |
| Nginx (Angular) | 80 | Serves the web UI and proxies API calls |
On first Docker run, ollama-init pulls phi3:mini from the Ollama registry (≈2.3 GB). Subsequent starts use the cached model from the ollama_storage volume.
3First-Time Setup
Logging In
Default credentials: username admin · password admin — change these immediately after first login.
- Open UniDocVerse (desktop app or
http://localhost). - Enter your username and password, then click Sign In.
- You're directed to the Dashboard.
Setup Checklist
| # | Where | What to do |
|---|---|---|
| 1 | Settings → Password | Change the default admin password |
| 2 | Settings → Features | Enable the industry modules your team needs |
| 3 | Settings → Users | Create accounts for additional team members |
| 4 | Sidebar → Language selector | Set your preferred UI and AI language |
| 5 | Upload | Upload your first document to verify the pipeline works |
Dashboard Overview
After login, the Dashboard shows your at-a-glance summary: total documents, active alerts, storage used, documents uploaded this week, a needs-attention list, a recent activity feed, and a document type distribution chart.
4Document Upload
Supported File Types
Maximum file size: 50 MB per file. Multiple files can be uploaded simultaneously.
How to Upload
- Click Upload in the left sidebar.
- Drag files onto the drop zone, or click Browse to select them.
- Watch each file's progress indicator — stages: Uploading → Extracting text → Running phi3:mini → Indexing.
- When status shows ✓ Analyzed, the document is ready.
What the AI Does Automatically
| Stage | What happens |
|---|---|
| Text extraction | OCR for scanned PDFs/images; native extraction for digital documents |
| Classification | Identifies document type (invoice, insurance policy, medical record, etc.) |
| Summary | Generates a 3–5 sentence executive summary |
| Key points | Extracts the most important facts, dates, figures, and obligations |
| Embeddings | Creates a vector representation for semantic search |
| Chunking | Splits text into overlapping segments for precise Q&A retrieval |
| Alerts | Flags expiring dates, anomalous amounts, missing required fields |
Document Sheet — Five Tabs
Click any document to open its detail panel:
Summary
AI-generated executive summary with confidence score. Click Regenerate if unsatisfactory.
Key Points
Bulleted list of the most important facts extracted from the document. Click Load More for additional points.
Analytics
Structured data extracted for this document type — amounts, dates, parties, coverage limits, diagnoses, etc.
Ask AI
Full conversational interface scoped to this document. Answers stream word-by-word with confidence scores. All conversations are stored in History.
Details
Metadata (filename, upload date, type, size), document preview, download, delete, and related documents via semantic similarity.
5Ask AI
Ask natural-language questions about any document — or across your entire library simultaneously.
Per-Document Questions
Open a document → click the Ask AI tab. Questions are answered using only that document's content. The AI adapts its role to the document type:
| Document type | AI role |
|---|---|
| Insurance policy | Coverage expert |
| Invoice | Accounts payable specialist |
| Contract / NDA | Legal document assistant |
| Medical record | Medical records specialist |
| Bank statement | Financial analyst |
| Any other type | General document assistant |
Global Ask AI
Click Ask AI in the sidebar navigation to search across all documents simultaneously. The system retrieves the most relevant passages from any document and generates a unified answer.
How Answers Are Generated
- Your question is converted to a vector embedding.
- pgvector finds the most semantically relevant text passages.
- phi3:mini generates an answer grounded only in those passages.
- The answer streams token-by-token as it is generated.
- A confidence score is calculated and displayed.
Hallucination-resistant: The AI only answers from content in your documents. If an answer cannot be found, it will say so rather than fabricate information.
6Semantic Search
The Search page uses pgvector to find documents by meaning, not just keywords. Searching "when does my coverage end?" finds policies with expiration dates even if those exact words don't appear in the document.
How to Search
- Click Search in the sidebar.
- Type a natural-language query in the search box.
- Results appear as you type (400ms debounce).
- Each result shows a match score — ≥70% Excellent 50–69% Good <50% Fair.
- Click Open → on any result to view the full document.
Use the Suggested Queries chips on the Search page for common industry-specific queries pre-optimized for your active modules.
7Conversation History
Every question you ask about any document is stored and searchable in the History page.
Layout
Left panel — all documents you've had conversations with, showing the most recent question, turn count, and time elapsed. Right panel — the full Q&A thread for the selected document, with questions in indigo bubbles and answers in white bubbles with confidence scores.
Searching Past Conversations
- Click History in the sidebar.
- Type in the search bar at the top of the sidebar panel.
- Matching Q&A pairs appear — click one to jump directly to that turn in the thread, highlighted.
Deleting Conversations
Hover over any Q&A card in the thread to reveal the delete button. Confirm in the prompt to remove that exchange. Use Load More at the bottom of the thread to paginate older conversations.
8Compliance Hub
Click Compliance in the sidebar to access three tabs: Deadlines, Alerts, and Audit Trail.
Alerts
Proactive alerts generated by document analysis, sorted by severity:
Filter by severity tab, search by filename, and click Open → to navigate directly to the source document.
Deadlines
All upcoming compliance-related deadlines extracted from documents, sorted by urgency. Mark deadlines as complete when resolved.
Audit Trail
Complete log of all system actions — uploads, deletions, questions asked, setting changes — with timestamp, user, and action type. Fully searchable.
9Analytics
The Analytics Hub provides collection-level insights about your document library: total document counts, type distribution, processing statistics, storage usage trends, and alert volume over time.
For per-document analytics, open any document and click the Analytics tab in the document sheet to see structured data extracted specifically for that document type.
10AI Agent
The AI Agent uses a ReAct (Reason + Act) loop to perform multi-step tasks across your document library. It can search documents, retrieve client data, analyze policies, and compile reports — autonomously, with your approval for sensitive actions.
Starting an Agent Run
- Click Automation in the sidebar, then the Agent tab.
- Type a task description (e.g., "Find all policies expiring in the next 30 days and summarize the coverage gaps").
- Click Run. The agent begins its reasoning loop.
- Each step is shown in real-time in the Agent Queue panel — tool calls, reasoning, and results.
- If the agent needs your approval for an action, it pauses and shows an approval card.
The agent uses phi3:mini for reasoning and has access to all UniDocVerse tools: document search, client lookup, policy retrieval, analytics, and more.
11Document Research Agent
The Document Research Agent is a multi-step AI reasoning engine that answers complex questions by autonomously searching, reading, and synthesizing information across your entire document library. Unlike single-document Q&A, it can cross-reference multiple documents, filter by type, and produce a comprehensive cited answer in one shot.
Find it under Analytics & Insights → Document Research Agent in the sidebar.
How It Works
The agent runs a ReAct loop (Reason + Act) — it thinks through your question, decides which tool to use next, observes the result, and repeats until it has enough evidence to write a final answer. Each step is shown in real time.
| Step | Tool | What it does |
|---|---|---|
| 🧠 | Understand Question | Breaks down your question into a research plan before taking any action |
| 🔍 | Search Documents | Runs a semantic vector search across your library to find the most relevant passages |
| 💬 | Ask Document | Asks a targeted question to a specific document and retrieves a grounded answer |
| 📋 | Filter Documents | Lists and filters documents by type, date, or keyword to narrow the search space |
| ✅ | Final Answer | Synthesizes all gathered evidence into a single, cited, comprehensive response |
Running a Research Query
- Navigate to Analytics & Insights → Document Research Agent.
- Type your question in the research input — or click one of the example chips to get started.
- Click Research. The agent begins its reasoning loop immediately.
- Watch each step appear in real time: tool name, its reasoning, and the result it observed.
- Click any step card to expand it and read the full detail of that reasoning step.
- The Final Answer appears at the bottom once all evidence is gathered.
Example Questions
Research History
Every research run is saved automatically. Access past research sessions from Analytics & Insights → Agent Conversation History. The history panel shows all prior questions in the left sidebar — click any entry to reload its full step-by-step reasoning and final answer.
Best for: complex multi-document questions, competitive analysis, portfolio reviews, compliance checks across many files, or any question that requires reading more than one document to answer fully.
12Industry Modules
UniDocVerse ships with optional industry modules enabled by an administrator in Settings → Features. Each module unlocks a set of sidebar sections and document hub tabs.
| Module | Unlocks in sidebar |
|---|---|
| 🏢 Agency Mode | Clients, Policies, Renewals, Commission, Loss Runs, COI, Quotes, Claims |
| ⚖️ Legal Mode | Matters, Contracts (CLM), NDAs, Lease Agreements, Regulatory Filings, Approvals |
| 🏥 Healthcare Mode | Medical Charts, Intake Forms, Lab Reports, Risk & Health |
| 💰 Finance Mode | Bank Statements, Tax Returns, Invoices |
| 🏠 Real Estate Mode | Appraisals, Title Deeds, Disclosures |
| 👥 HR & People Mode | Resumes, Handbooks, Performance Reviews |
| 📦 Supply Chain Mode | PO Register, Bills of Lading, Manifests |
| ✅ Compliance & Risk | Compliance, Risk, Audit, and Deadlines pages |
| ⚙️ Operations Mode | Matters, Claims, Approvals, Quotes, CLM, Jurisdiction |
Enabling a Module
- Log in as an administrator.
- Go to Settings → Features.
- Toggle the desired module On.
- The sidebar immediately shows the new section — no restart needed.
13MCP / AI Integration
UniDocVerse exposes a Model Context Protocol (MCP) server at http://localhost:8000/mcp/sse. Connect it to AI coding tools to query your documents and run UniDocVerse tools from inside your AI assistant.
Important privacy notice — please read before enabling MCP.
UniDocVerse is designed to be 100% private and local. Your documents never leave your machine when you use the app normally. MCP integration changes this.
When you connect an AI client (such as Claude Desktop, Cursor, Zed, Windsurf, or Continue), that client can query your UniDocVerse documents on your behalf. Every query — including document text, extracted summaries, key points, client names, policy numbers, financial figures, medical details, and any other content in your library — is sent to that AI client. The AI client then forwards this data to its own cloud servers (for example, Anthropic's servers for Claude Desktop, or the respective vendor's servers for other clients).
What this means in plain terms:
- Your document content may be used to train or improve third-party AI models, depending on that vendor's data policy.
- Sensitive PII (names, addresses, SSNs, dates of birth) in your documents may be transmitted to and stored on external servers.
- Protected health information (PHI), privileged legal communications, and confidential financial records are equally at risk.
- Once data leaves your machine via the AI client, UniDocVerse has no control over how it is handled, retained, or shared.
Recommendation: Only enable MCP integration if your document library contains non-sensitive or already-public information, and you have reviewed and accepted the privacy policy of the AI client you are connecting. If you handle regulated data (HIPAA, GDPR, SOC 2, attorney-client privilege), do not enable MCP.
Auto-configure: Open UniDocVerse → Settings → Integrations → click Connect next to any supported client. UniDocVerse automatically writes the correct config file for you.
Supported Clients
What You Can Do via MCP
Once connected, your AI client can call any UniDocVerse tool — search documents, query clients and policies, retrieve analytics, manage approvals, run the AI agent, and more — directly from within your AI assistant's chat or code completion interface.
14Admin & Settings
The Settings page is only visible to administrators. It has four tabs:
Users Tab
| Action | How |
|---|---|
| Add a user | Fill in full name, username, password, and role (Admin / User) → click Add User |
| Disable a user | Toggle the active switch next to their name |
| Delete a user | Click the trash icon (permanent — cannot be undone) |
| Reset password | Click the user row and enter a new password |
Features Tab
Enable or disable industry modules, compliance/risk, and operations sections. Changes take effect instantly with no restart required.
Password Tab
Change your own account password. Enter current password, new password, and confirm. Minimum 8 characters.
RBAC — Roles
| Role | Capabilities |
|---|---|
| Admin | Full access — all pages, Settings, user management, feature flags |
| User | Upload, query, search, history, compliance — cannot access Settings |
15Report an Issue
Found a bug, have a feature request, or need to ask a question? Use the Report Issue form built directly into UniDocVerse — no external tools or email required.
Find it in the sidebar under Report Issue (available to all users).
How to Submit an Issue
- Click Report Issue in the left sidebar.
- Enter a clear Title summarizing the problem or request.
- Choose an Issue Type:
| Type | When to use |
|---|---|
| 🐛 Bug | Something is broken or not working as expected |
| ✨ Feature Request | You'd like a new capability added to the platform |
| ⚡ Improvement | An existing feature that could work better |
| ❓ Question | You need clarification on how something works |
- Set a Priority — Critical High Medium Low
- Write a detailed Description — include steps to reproduce, what you expected, and what actually happened.
- Click Submit. You'll see a confirmation once it's received.
Who Can See Your Report?
Only administrators can view submitted issues. Regular users can submit reports but cannot see the issue tracker or any reports submitted by others. Your report goes directly to your platform administrator — it is not sent to any external service or the UniDocVerse team.
Administrators can view, manage, and act on all submitted issues from the Settings → Issue Tracker page.
16Troubleshooting
docker compose logs ollama to check if the model was pulled successfully.~/Library/Application Support/unidocverse/logs/backend.log for errors. Encrypted or password-protected PDFs cannot be processed.docker-compose.yml to remap the conflicting port (e.g., change "80:80" to "8080:80" for the frontend).17System Requirements
| Component | Minimum | Recommended |
|---|---|---|
| Operating system | macOS 13 Ventura | macOS 14+ (Apple Silicon) |
| RAM | 16 GB | 32 GB |
| Storage | 10 GB free | 20 GB free |
| CPU | 8-core Intel Core i7 / i9 (10th gen+) | Apple M2 / M3 / M4 |
| Docker (server mode) | Docker Engine 24+ | Docker Desktop (latest) |
The DMG is a universal binary — a single installer works on both Apple Silicon (arm64) and Intel (x86_64) Macs. No separate downloads needed.