Skip to content

Installation Guide

This guide covers various methods to install and run Readur, from quick Docker deployment to manual installation.

Table of Contents

Quick Start with Docker Compose

The fastest way to get Readur running:

# Clone the repository
git clone https://github.com/perfectra1n/readur
cd readur

# Start all services
docker compose up --build -d

# Access the application
open http://localhost:8000

Default login credentials: - Username: admin - Password: readur2024

⚠️ Important: Change the default admin password immediately after first login!

What You Get

After deployment, you'll have: - Web Interface: Modern document management UI at http://localhost:8000 - PostgreSQL Database: Document metadata and full-text search indexes - File Storage: Persistent document storage with OCR processing - Watch Folder: Automatic file ingestion from mounted directories - REST API: Full API access for integrations

System Requirements

Minimum Requirements

  • CPU: 2 cores
  • RAM: 2GB
  • Storage: 10GB free space
  • OS: Linux, macOS, or Windows with Docker
  • CPU: 4+ cores
  • RAM: 4GB+
  • Storage: 50GB+ SSD
  • Network: Stable internet connection for OCR processing

Manual Installation

For development or custom deployments without Docker:

Prerequisites

Install these dependencies on your system:

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install -y \
    tesseract-ocr tesseract-ocr-eng \
    libtesseract-dev libleptonica-dev \
    postgresql postgresql-contrib \
    pkg-config libclang-dev

# macOS (requires Homebrew)
brew install tesseract leptonica postgresql rust nodejs npm

# Install Rust (if not already installed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Backend Setup

  1. Configure Database: 

    # Create database and user
sudo -u postgres psql
CREATE DATABASE readur;
CREATE USER readur_user WITH ENCRYPTED PASSWORD 'your_password';
GRANT ALL PRIVILEGES ON DATABASE readur TO readur_user;
\q

  2. Environment Configuration: 

    # Copy environment template
cp .env.example .env

# Edit configuration
nano .env

Required environment variables: 

DATABASE_URL=postgresql://readur_user:your_password@localhost/readur
JWT_SECRET=your-super-secret-jwt-key-change-this
SERVER_ADDRESS=0.0.0.0:8000
UPLOAD_PATH=./uploads
WATCH_FOLDER=./watch
ALLOWED_FILE_TYPES=pdf,png,jpg,jpeg,gif,bmp,tiff,txt,rtf,doc,docx

  1. Build and Run Backend: 
    # Install dependencies and run
cargo build --release
cargo run

Frontend Setup

  1. Install Dependencies: 

    cd frontend
npm install

  2. Development Mode: 

    npm run dev
# Frontend available at http://localhost:5173

  3. Production Build: 

    npm run build
# Built files in frontend/dist/

Verifying Installation

After installation, verify everything is working:

  1. Check Backend Health: 

    curl http://localhost:8000/api/health

  2. Access Web Interface:

  3. Navigate to http://localhost:8000
  4. Log in with default credentials

  5. Upload a test document

  6. Verify Database Connection: 

    # For Docker installation
docker exec -it readur-postgres-1 psql -U readur -c "\dt"

# For manual installation
psql -U readur_user -d readur -c "\dt"

  7. Check OCR Functionality:

  8. Upload a PDF or image file
  9. Wait for processing to complete
  10. Search for text content from the uploaded file

Next Steps