128 lines
3.0 KiB
Markdown
128 lines
3.0 KiB
Markdown
# Mulita - Self-Hosted Photo Management Application
|
|
|
|
A self-hosted, Docker-deployed photo management application inspired by Lightroom's workflow. Mulita provides a fast, keyboard-driven interface to browse, organize, tag, and manage your photo library.
|
|
|
|
## Features
|
|
|
|
- **Photo Organization**: Browse photos in a timeline view with virtual scrolling for performance
|
|
- **Thumbnail Generation**: Automatic thumbnail generation for all photo formats including RAW
|
|
- **Metadata Extraction**: Full EXIF/XMP metadata extraction and search
|
|
- **Keyboard Shortcuts**: Lightroom-style keyboard navigation and actions
|
|
- **File Support**: JPEG, PNG, RAW formats (CR2, CR3, NEF, ARW, etc.), HEIC/HEIF, and videos
|
|
- **Heaps**: Temporary collections for organizing photos
|
|
- **Tags & Ratings**: Organize with tags, star ratings, and color labels
|
|
- **Dark Mode**: Photography-optimized dark interface
|
|
|
|
## Tech Stack
|
|
|
|
### Backend
|
|
- Python 3.12 with FastAPI
|
|
- SQLite with SQLAlchemy (async)
|
|
- Celery + Redis for background tasks
|
|
- pyvips for fast thumbnail generation
|
|
- ExifTool for metadata extraction
|
|
|
|
### Frontend
|
|
- React 18 with TypeScript
|
|
- Vite for fast development
|
|
- TanStack Query for data fetching
|
|
- TanStack Virtual for virtualized scrolling
|
|
- Tailwind CSS for styling
|
|
- Zustand for state management
|
|
|
|
## Quick Start
|
|
|
|
### Prerequisites
|
|
- Docker and Docker Compose
|
|
- Photo directories to mount
|
|
|
|
### Setup
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone <repository-url>
|
|
cd muleimage
|
|
```
|
|
|
|
2. Configure your photo directories in `.env`:
|
|
```bash
|
|
# Edit .env file
|
|
PHOTO_DIRS=/path/to/your/photos
|
|
```
|
|
|
|
3. Start the application:
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
4. Access the application at `http://localhost:3000`
|
|
|
|
## Architecture
|
|
|
|
The application consists of 5 Docker services:
|
|
|
|
- **frontend**: React SPA served by Nginx
|
|
- **backend**: FastAPI REST API
|
|
- **worker**: Celery workers for background tasks
|
|
- **redis**: Message broker for Celery
|
|
- **db**: SQLite database (file-based)
|
|
|
|
## Keyboard Shortcuts
|
|
|
|
| Key | Action |
|
|
|-----|--------|
|
|
| `←` `→` `↑` `↓` | Navigate photos |
|
|
| `Space` | Quick preview |
|
|
| `Enter` | Open loupe view |
|
|
| `P` | Pick photo |
|
|
| `X` | Reject photo |
|
|
| `1-5` | Set star rating |
|
|
| `Tab` | Toggle left sidebar |
|
|
| `I` | Toggle metadata panel |
|
|
| `G` | Grid view |
|
|
| `E` | Loupe view |
|
|
| `Delete` | Move to trash |
|
|
|
|
## Development
|
|
|
|
### Backend Development
|
|
```bash
|
|
cd backend
|
|
pip install -r requirements.txt
|
|
uvicorn app.main:app --reload
|
|
```
|
|
|
|
### Frontend Development
|
|
```bash
|
|
cd frontend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Edit `mulita.yml` to configure:
|
|
- Source photo directories
|
|
- Thumbnail sizes and quality
|
|
- Scanner settings
|
|
- Performance tuning
|
|
|
|
## Performance
|
|
|
|
- Handles 100,000+ photos efficiently
|
|
- Virtual scrolling for smooth timeline navigation
|
|
- Thumbnail generation at 10+ photos/second
|
|
- SQLite FTS5 for fast full-text search
|
|
|
|
## Future Features (Phase 2)
|
|
|
|
- AI-powered scene classification
|
|
- Face detection and clustering
|
|
- Smart albums
|
|
- Duplicate detection
|
|
- Export presets
|
|
- Multi-user support
|
|
|
|
## License
|
|
|
|
MIT |