- 🖥 Modern UI: Built with Vue 3 + Composition API, providing a smooth SPA experience and a beautiful design perfectly adapted for both desktop and mobile.
- 📖 Immersive Web Reader: Built-in powerful web reader. Seamlessly open and read PDF and EPUB formats directly without downloading.
- ⚡️ Blazing Fast Backend: Powered by Python FastAPI with a fully asynchronous architecture for rapid responses.
- 🕷 Smart Metadata Scraper: Automatically fetch book titles, authors, publishers, descriptions, and high-res covers from external sources (e.g., Douban).
- 💾 Native Download Streaming: Supports browser-native download progress bars, streaming large files directly from the server to prevent memory exhaustion.
- 🔒 Secure & Robust: Hardened against common self-hosting security risks like Path Traversal and SSRF, ensuring your personal data stays safe.
- 🚀 Zero-config Startup: The backend automatically initializes the SQLite database and necessary structures out-of-the-box.
- Core Framework: Vue 3 (Composition API)
- Routing: Vue Router
- HTTP Client: Axios
- Reader Core: PDF.js, Epub.js
- Build Tool: Vite
- Core Framework: FastAPI (Python)
- Database & ORM: SQLite, SQLAlchemy
- Migrations: Alembic
- Validation: Pydantic
- Security: JWT Authentication, bcrypt Password Hashing
You can quickly deploy Metomi using Docker. A unified image that includes both the frontend and backend is provided via docker-compose.yml in the project root.
- Download the configuration file
mkdir metomi && cd metomi wget https://raw.githubusercontent.com/SiwayLab/metomi/refs/heads/main/docker-compose.yml
- Start the service:
docker-compose up -d
- Access the system:
Open your browser and navigate to
http://localhost:8000.
Ensure you have Python 3.9+ and Node.js 16+ installed.
cd backend
python -m venv .venv
source .venv/bin/activate # On Windows, use .venv\Scripts\activate
pip install -r requirements.txt
uvicorn app.main:app --host 0.0.0.0 --port 8000 --reloadcd frontend
npm install
npm run devIssues and Pull Requests are welcome! This started as a personal self-hosted project, but we believe open source can make it even better. If you find this project helpful, please give it a ⭐️ Star!
This project is licensed under the MIT License.