Skip to content

SETUP.md

Latest commit

 

History

History
175 lines (128 loc) · 3.52 KB

SETUP.md

File metadata and controls

175 lines (128 loc) · 3.52 KB

Quick Setup Guide

This guide will help you get Enarro up and running quickly.

Prerequisites

Before you begin, ensure you have the following installed:

Step-by-Step Setup

1. Clone the Repository

git clone https://github.com/yourusername/enarro.git
cd enarro

2. Install Ollama Models

# Pull the chat model (phi3)
ollama pull phi3

# Pull the embedding model
ollama pull nomic-embed-text

# Verify models are installed
ollama list

3. Restore NuGet Packages

dotnet restore

4. Start the Application

# Run with .NET Aspire (recommended)
dotnet run --project Enarro.AppHost

This will:

  • ✅ Start PostgreSQL container
  • ✅ Start Redis container
  • ✅ Start Qdrant container
  • ✅ Start Ollama container
  • ✅ Run database migrations
  • ✅ Launch the API
  • ✅ Open Aspire dashboard

5. Access the Application

Once started, you can access:

Service URL
API https://localhost:7001
Swagger UI https://localhost:7001/swagger
Aspire Dashboard https://localhost:15888
Health Checks https://localhost:7001/health

Quick Test

Upload a Document

curl -X POST "https://localhost:7001/api/v1/ingest" \
  -H "accept: application/json" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/your/document.pdf"

Ask a Question

curl -X POST "https://localhost:7001/api/v1/chat" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "What is this document about?",
    "minRelevance": 0.3
  }'

Check Health

curl https://localhost:7001/health

Troubleshooting

Docker Not Running

Error: Docker is not running

Solution: Start Docker Desktop

Ollama Models Not Found

Error: Model 'phi3' not found

Solution: Run ollama pull phi3 and ollama pull nomic-embed-text

Port Already in Use

Error: Port 7001 is already in use

Solution: Stop the conflicting application or change the port in Enarro/Properties/launchSettings.json

Database Migration Errors

Error: Unable to create migration

Solution: Ensure PostgreSQL container is running and connection string is correct

Next Steps

  1. Explore the API - Visit https://localhost:7001/swagger
  2. Monitor Services - Check Aspire dashboard at https://localhost:15888
  3. Upload Documents - Try uploading different document types
  4. Test Chat - Ask questions about your uploaded documents
  5. Check Logs - View logs in logs/enarro-[date].log

Configuration

To customize the application, edit Enarro/appsettings.json:

{
  "RAGConfigs": {
    "ChatModel": "phi3",
    "EmbeddingModel": "nomic-embed-text",
    "Retrieval": {
      "MinRelevance": 0.3,
      "MaxResults": 5
    }
  }
}

Development Mode

For development with hot reload:

dotnet watch --project Enarro

Stopping the Application

Press Ctrl+C in the terminal where Aspire is running.

To stop and remove all containers:

docker compose down

Need Help?

Happy coding! 🚀