gotson/komga
Komga
Komga is a self-hosted digital comics and eBook server that organizes, serves, and streams CBZ, CBR, PDF, and EPUB files through a web interface. Built as a Java Spring Boot application with SQLite-based metadata storage, it provides multi-user access controls with individual reading progress tracking and supports the OPDS protocol for compatibility with third-party reader applications.
The server distinguishes itself through comprehensive authentication options, including OAuth2 and OpenID Connect support with automatic account creation and email verification, alongside traditional cookie and token-based session management with configurable timeouts and remember-me persistence. It offers a file-system scanning engine that automatically detects new, changed, or removed files, and provides duplicate detection and removal for both files and pages. The platform supports organizing content into libraries with per-user access restrictions, grouping series into collections, and creating custom reading lists.
Additional capabilities include full-text search across all libraries, metadata editing for books and series, trash-based recovery for deleted content, and the ability to import books from outside library folders. The server can be deployed on multiple platforms including Windows, macOS, and Linux, with installation options ranging from a native desktop application and Microsoft Store to Docker containers and direct Java JAR execution.
Features
- Comic Book Libraries - Serves a personal collection of comics, mangas, and eBooks through a web interface.
- Containerized Spring Boot Applications - Runs as a self-contained Java application using Spring Boot for HTTP request handling and dependency injection.
- Comic Archive Readers - Provides built-in reading of CBZ and CBR comic archives by decompressing ZIP and RAR formats.
- Multi-Library Managers - Creates separate user accounts with individual reading progress, access controls, and session management.
- Metadata Organizers - Edits book and series metadata, groups content into collections, and scans libraries to keep the catalog current.
- Reading Progress Tracking - Records which books a user has read or is currently reading with progress stored per user.
- SQLite Storage Adapters - Stores all application data and background tasks in separate SQLite databases for reliable local persistence.
- Library Organizers - Groups content into user-defined libraries by type, such as comics or eBooks, for structured browsing.
- Access-Controlled - Separates books into distinct groups, each with its own access restrictions for different users.
- Comic Archive Readers - Opens and displays CBZ and CBR archive files, with support for RAR5 on most platforms.
- Session & Cookie Handlers - Creates reusable sessions after login using cookies or custom headers with configurable timeouts.
- User-Based Access Restrictions - Separates content into libraries with per-user access restrictions and tracks individual reading progress.
- User Account Management - Creates and manages separate user accounts with individual access controls and reading progress tracking.
- Ebook File Readers - Opens and displays EPUB and PDF files directly within the server interface.
- Library Directory Scanners - Scans configured library directories to detect new, changed, or removed files and updates metadata.
- Ebook Metadata Editing - Modifies embedded details such as summaries and release dates to improve browsing information.
- External File Importers - Adds files located outside existing library folders directly into a series folder.
- Multi-Platform Readers - Opens books in the integrated webreader, a mobile extension, or any OPDS-compatible reader.
- Metadata Refreshing - Processes library files to match them to series and books and updates metadata as content changes.
- Full Text Search - Performs full-text searches to find relevant books and series from any library.
- Docker-Based Deployment Tools - Runs the media server inside a Docker container for isolated and portable deployment.
- Cross-Platform Deployments - Operates on Windows, macOS, Linux, and popular NAS devices using Java or Docker.
- Custom - Gathers specific books into ordered playlists, such as all appearances of a character.
- OPDS Servers - Opens books in any OPDS-compatible reader app for flexible reading across devices.
- API Key Authentication - Accepts credentials through HTTP Basic Authentication or an API key in the X-API-Key header to secure access.
- Remember-Me Persistence - Issues a long-lived cookie during authentication that re-logs in the user automatically after a session expires.
- Auto-Creation on OAuth Login - Automatically creates a new user account when an OAuth2 or OIDC login succeeds for an unknown email address.
- OAuth2 Providers - Supports OAuth2 and OpenID Connect login flows with automatic account creation and email verification.
- Session Authentication - Terminates an existing session on request by invalidating the authentication token or cookie.
- Trash Managers - Holds removed library items in a trash folder until permanently emptied to prevent accidental data loss.
- Series Grouping - Assembles related series together under a single label for easier browsing.
- E-book Libraries - Media server with a web reader for comics and manga.
- Ebook Library Management - Media server and web reader for comics and manga.
- Document Management - Listed in the “Document Management” section of the Awesome Selfhosted awesome list.
