Manual Installation (Preferred)

This guide provides step-by-step instructions for setting up SurfSense without Docker. This approach gives you more control over the installation process and allows for customization of the environment.

Prerequisites

Before beginning the manual installation, ensure you have the following installed and configured:

Required Software

• Python 3.12+ - Backend runtime environment
• Node.js 20+ - Frontend runtime environment
• PostgreSQL 14+ - Database server
• PGVector - PostgreSQL extension for vector similarity search
• Redis - Message broker for Celery task queue
• Git - Version control (to clone the repository)

Required Services & API Keys

Complete all the setup steps, including:

• Authentication Setup (choose one):
  • Google OAuth credentials (for AUTH_TYPE=GOOGLE)
  • Local authentication setup (for AUTH_TYPE=LOCAL)
• File Processing ETL Service (choose one):
  • Unstructured.io API key (Supports 34+ formats)
  • LlamaCloud API key (enhanced parsing, supports 50+ formats)
  • Docling (local processing, no API key required, supports PDF, Office docs, images, HTML, CSV)
• Other API keys as needed for your use case

Backend Setup

The backend is the core of SurfSense. Follow these steps to set it up:

1. Environment Configuration

First, create and configure your environment variables by copying the example file:

Linux/macOS:

cd surfsense_backend
cp .env.example .env

Windows (Command Prompt):

cd surfsense_backend
copy .env.example .env

Windows (PowerShell):

cd surfsense_backend
Copy-Item -Path .env.example -Destination .env

Edit the .env file and set the following variables:

(Optional) Backend LangSmith Observability:

(Optional) Uvicorn Server Configuration

Refer to the .env.example file for all available Uvicorn options and their usage. Uncomment and set in your .env file as needed.

For more details, see the Uvicorn documentation.

2. Install Dependencies

Install the backend dependencies using uv:

Linux/macOS:

# Install uv if you don't have it
curl -fsSL https://astral.sh/uv/install.sh | bash

# Install dependencies
uv sync

Windows (PowerShell):

# Install uv if you don't have it
iwr -useb https://astral.sh/uv/install.ps1 | iex

# Install dependencies
uv sync

Windows (Command Prompt):

# Install dependencies with uv (after installing uv)
uv sync

3. Start Redis Server

Redis is required for Celery task queue. Start the Redis server:

Linux:

# Start Redis server
sudo systemctl start redis

# Or if using Redis installed via package manager
redis-server

macOS:

# If installed via Homebrew
brew services start redis

# Or run directly
redis-server

Windows:

# Option 1: If using Redis on Windows (via WSL or Windows port)
redis-server

# Option 2: If installed as a Windows service
net start Redis

Alternative for Windows - Run Redis in Docker:

If you have Docker Desktop installed, you can run Redis in a container:

# Pull and run Redis container
docker run -d --name redis -p 6379:6379 redis:latest

# To stop Redis
docker stop redis

# To start Redis again
docker start redis

# To remove Redis container
docker rm -f redis

Verify Redis is running by connecting to it:

redis-cli ping
# Should return: PONG

4. Start Celery Worker

In a new terminal window, start the Celery worker to handle background tasks:

Linux/macOS/Windows:

# Make sure you're in the surfsense_backend directory
cd surfsense_backend

# Start Celery worker
uv run celery -A celery_worker.celery_app worker --loglevel=info --concurrency=1 --pool=solo

Optional: Start Flower for monitoring Celery tasks:

In another terminal window:

# Start Flower (Celery monitoring tool)
uv run celery -A celery_worker.celery_app flower --port=5555

Access Flower at http://localhost:5555 to monitor your Celery tasks.

5. Start Celery Beat (Scheduler)

In another new terminal window, start Celery Beat to enable periodic tasks (like scheduled connector indexing):

Linux/macOS/Windows:

# Make sure you're in the surfsense_backend directory
cd surfsense_backend

# Start Celery Beat
uv run celery -A celery_worker.celery_app beat --loglevel=info

Important: Celery Beat is required for the periodic indexing functionality to work. Without it, scheduled connector tasks won't run automatically. The schedule interval can be configured using the SCHEDULE_CHECKER_INTERVAL environment variable.

6. Run the Backend

Start the backend server:

Linux/macOS/Windows:

# Run without hot reloading
uv run main.py

# Or with hot reloading for development
uv run main.py --reload

If everything is set up correctly, you should see output indicating the server is running on http://localhost:8000.

Frontend Setup

1. Environment Configuration

Set up the frontend environment:

Linux/macOS:

cd surfsense_web
cp .env.example .env

Windows (Command Prompt):

cd surfsense_web
copy .env.example .env

Windows (PowerShell):

cd surfsense_web
Copy-Item -Path .env.example -Destination .env

Edit the .env file and set:

2. Install Dependencies

Install the frontend dependencies:

Linux/macOS:

# Install pnpm if you don't have it
npm install -g pnpm

# Install dependencies
pnpm install

Windows:

# Install pnpm if you don't have it
npm install -g pnpm

# Install dependencies
pnpm install

3. Run the Frontend

Start the Next.js development server:

Linux/macOS/Windows:

pnpm run dev

The frontend should now be running at http://localhost:3000.

Browser Extension Setup (Optional)

The SurfSense browser extension allows you to save any webpage, including those protected behind authentication.

1. Environment Configuration

Linux/macOS:

cd surfsense_browser_extension
cp .env.example .env

Windows (Command Prompt):

cd surfsense_browser_extension
copy .env.example .env

Windows (PowerShell):

cd surfsense_browser_extension
Copy-Item -Path .env.example -Destination .env

Edit the .env file:

2. Build the Extension

Build the extension for your browser using the Plasmo framework.

Linux/macOS/Windows:

# Install dependencies
pnpm install

# Build for Chrome (default)
pnpm build

# Or for other browsers
pnpm build --target=firefox
pnpm build --target=edge

3. Load the Extension

Load the extension in your browser's developer mode and configure it with your SurfSense API key.

Verification

To verify your installation:

1. Open your browser and navigate to http://localhost:3000
2. Sign in with your Google account
3. Create a search space and try uploading a document
4. Test the chat functionality with your uploaded content

Troubleshooting

• Database Connection Issues: Verify your PostgreSQL server is running and pgvector is properly installed
• Redis Connection Issues: Ensure Redis server is running (redis-cli ping should return PONG). Check that CELERY_BROKER_URL and CELERY_RESULT_BACKEND are correctly set in your .env file
• Celery Worker Issues: Make sure the Celery worker is running in a separate terminal. Check worker logs for any errors
• Authentication Problems: Check your Google OAuth configuration and ensure redirect URIs are set correctly
• LLM Errors: Confirm your LLM API keys are valid and the selected models are accessible
• File Upload Failures: Validate your ETL service API key (Unstructured.io or LlamaCloud) or ensure Docling is properly configured
• Windows-specific: If you encounter path issues, ensure you're using the correct path separator (\ instead of /)
• macOS-specific: If you encounter permission issues, you may need to use sudo for some installation commands

Next Steps

Now that you have SurfSense running locally, you can explore its features:

• Create search spaces for organizing your content
• Upload documents or use the browser extension to save webpages
• Ask questions about your saved content
• Explore the advanced RAG capabilities

For production deployments, consider setting up:

• A reverse proxy like Nginx
• SSL certificates for secure connections
• Proper database backups
• User access controls