5.8 KiB

Raw Blame History

Readur 📄

A powerful, modern document management system built with Rust and React. Readur provides intelligent document processing with OCR capabilities, full-text search, and a beautiful web interface designed for 2026 tech standards.

✨ Features

🔐 Secure Authentication: JWT-based user authentication with bcrypt password hashing + OIDC/SSO support
👥 User Management: Role-based access control with Admin and User roles
📤 Smart File Upload: Drag-and-drop support for PDF, images, text files, and Office documents
🔍 Advanced OCR: Automatic text extraction using Tesseract for searchable document content
🔎 Powerful Search: PostgreSQL full-text search with multiple modes (simple, phrase, fuzzy, boolean)
🔗 Multi-Source Sync: WebDAV, Local Folders, and S3-compatible storage integration
🏷️ Labels & Organization: Comprehensive tagging system with color-coding and hierarchical structure
👁️ Folder Monitoring: Non-destructive file watching with intelligent sync scheduling
📊 Health Monitoring: Proactive source validation and system health tracking
🔔 Notifications: Real-time alerts for sync events, OCR completion, and system status
🎨 Modern UI: Beautiful React frontend with Material-UI components and responsive design
🐳 Docker Ready: Complete containerization with production-ready multi-stage builds
⚡ High Performance: Rust backend for speed and reliability
📊 Analytics Dashboard: Document statistics and processing status overview

🚀 Quick Start

# 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!

📚 Documentation

Getting Started

📦 Installation Guide - Docker & manual installation instructions
🔧 Configuration - Environment variables and settings
📖 User Guide - How to use Readur effectively

Core Features

🔗 Sources Guide - WebDAV, Local Folders, and S3 integration
👥 User Management - Authentication, roles, and administration
🏷️ Labels & Organization - Document tagging and categorization
🔎 Advanced Search - Search modes, syntax, and optimization
🔐 OIDC Setup - Single Sign-On integration

Deployment & Operations

🚀 Deployment Guide - Production deployment, SSL, monitoring
🔄 Reverse Proxy Setup - Nginx, Traefik, and more
📁 Watch Folder Guide - Automatic document ingestion

Development

🏗️ Developer Documentation - Architecture, development setup, testing
🔌 API Reference - REST API documentation

Advanced Topics

🔍 OCR Optimization - Improve OCR performance
🗄️ Database Best Practices - Concurrency and safety
📊 Queue Architecture - Background job processing

🏗️ Architecture

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   React Frontend │────│   Rust Backend  │────│  PostgreSQL DB  │
│   (Port 8000)   │    │   (Axum API)    │    │   (Port 5433)   │
└─────────────────┘    └─────────────────┘    └─────────────────┘
         │                       │                       │
         │              ┌─────────────────┐             │
         └──────────────│  File Storage   │─────────────┘
                        │  + OCR Engine   │
                        └─────────────────┘

📋 System Requirements

Minimum

2 CPU cores, 2GB RAM, 10GB storage
Docker or manual installation prerequisites

Recommended for Production

4+ CPU cores, 4GB+ RAM, 50GB+ SSD
See deployment guide for details

🤝 Contributing

We welcome contributions! Please see our Contributing Guide and Development Setup for details.

🔒 Security

Change default credentials immediately
Use HTTPS in production
Regular security updates
See deployment guide for security best practices

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Tesseract OCR for text extraction
Axum for the web framework
Material-UI for the beautiful frontend components
PostgreSQL for robust full-text search

Screenshots

📞 Support

Documentation: Start with the User Guide
Issues: Report bugs on GitHub Issues
Discussions: Join our GitHub Discussions

Made with ❤️ and ☕ by the Readur team

5.8 KiB Raw Blame History