3bf1575ca8
Updated service configurations, added new services, removed deprecated ones, and improved gitignore patterns for better repository hygiene. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
82 lines
2.6 KiB
Markdown
82 lines
2.6 KiB
Markdown
# Komga
|
|
|
|
Komga is a free and open source comics/ebooks server with OPDS support and Kobo/KOReader integration.
|
|
|
|
## Features
|
|
|
|
- Modern web interface for browsing comics and ebooks
|
|
- OPDS feed support for reading apps
|
|
- Native Kobo sync support (connect your Kobo eReader directly)
|
|
- KOReader integration via OPDS
|
|
- Metadata management
|
|
- User management with per-library access control
|
|
- Reading progress tracking
|
|
|
|
## Configuration
|
|
|
|
### Environment Variables
|
|
|
|
See `.env` file for configuration options:
|
|
- `KOMGA_PORT`: Internal port for Komga (default: 8080)
|
|
- `TRAEFIK_HOST`: Public domain for accessing Komga
|
|
- `TZ`: Timezone
|
|
- `APP_USER_ID`/`APP_GROUP_ID`: User/group for file permissions
|
|
|
|
### Volumes
|
|
|
|
- `./config`: Komga configuration and database
|
|
- `/mnt/media/books`: Your book/comic library (read-only recommended)
|
|
- `/mnt/media/bookdrop`: Drop folder for importing new content
|
|
|
|
## Kobo Setup
|
|
|
|
Komga has built-in Kobo sync support. To connect your Kobo eReader:
|
|
|
|
1. Access Komga web UI and create a user account
|
|
2. In Komga user settings, generate a Kobo sync token
|
|
3. On your Kobo device:
|
|
- Connect via USB
|
|
- Edit `.kobo/Kobo/Kobo eReader.conf`
|
|
- Add under `[OneStoreServices]`:
|
|
```
|
|
api_endpoint=https://books.fig.systems/kobo
|
|
```
|
|
4. Safely eject and reboot your Kobo
|
|
5. Sign in with your Komga credentials when prompted
|
|
|
|
The Kobo endpoint (`/kobo`) is configured to bypass Authelia authentication since Kobo uses its own authentication mechanism.
|
|
|
|
## KOReader Setup
|
|
|
|
For KOReader (on any device):
|
|
|
|
1. Open KOReader
|
|
2. Go to Tools → OPDS Catalog
|
|
3. Add new catalog:
|
|
- Catalog Name: Komga
|
|
- Catalog URL: `https://books.fig.systems/opds/v1.2/catalog`
|
|
- Username: Your Komga username
|
|
- Password: Your Komga password
|
|
|
|
Note: The OPDS endpoints require Authelia authentication for web access, but KOReader will authenticate using HTTP Basic Auth with your Komga credentials.
|
|
|
|
## Authentication
|
|
|
|
- Web UI: Protected by Authelia SSO
|
|
- OPDS/Kobo endpoints: Use Komga's built-in authentication
|
|
- The Kobo sync endpoint bypasses Authelia to allow direct device authentication
|
|
|
|
## First Run
|
|
|
|
1. Start the service: `docker compose up -d`
|
|
2. Access the web UI at `https://books.fig.systems`
|
|
3. Create an admin account on first login
|
|
4. Add libraries pointing to your book folders
|
|
5. Configure users and permissions as needed
|
|
|
|
## Tips
|
|
|
|
- Komga supports various formats: CBZ, CBR, PDF, EPUB, and more
|
|
- Use the bookdrop folder for automatic import scanning
|
|
- Enable "claim" profile for better reverse proxy support (already configured)
|
|
- Kobo sync requires HTTPS (already configured via Traefik)
|