komga/README.md

56 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2021-06-21 15:23:55 +08:00
[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/komga?label=OpenCollective%20Sponsors&color=success)](https://opencollective.com/komga) [![GitHub Sponsors](https://img.shields.io/github/sponsors/gotson?label=Github%20Sponsors&color=success)](https://github.com/sponsors/gotson)
2021-01-05 10:04:17 +08:00
[![Discord](https://img.shields.io/discord/678794935368941569?label=Discord&color=blue)](https://discord.gg/TdRpkDu)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/gotson/komga/tests.yml?branch=master)](https://github.com/gotson/komga/actions?query=workflow%3ATests+branch%3Amaster)
2021-06-21 15:23:55 +08:00
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/gotson/komga?color=blue&label=download&sort=semver)](https://github.com/gotson/komga/releases) [![GitHub all releases](https://img.shields.io/github/downloads/gotson/komga/total?color=blue&label=github%20downloads)](https://github.com/gotson/komga/releases)
2019-09-02 17:46:27 +08:00
[![Docker Pulls](https://img.shields.io/docker/pulls/gotson/komga)](https://hub.docker.com/r/gotson/komga)
[![Translation status](https://hosted.weblate.org/widgets/komga/-/webui/svg-badge.svg)](https://hosted.weblate.org/engage/komga/)
2019-08-21 15:51:00 +08:00
# ![app icon](./.github/readme-images/app-icon.png) Komga
2023-11-28 12:43:16 +08:00
Komga is a media server for your comics, mangas, BDs, magazines and eBooks.
2019-08-21 15:51:00 +08:00
2020-02-20 09:22:32 +08:00
#### Chat on [Discord](https://discord.gg/TdRpkDu)
2020-02-17 11:10:04 +08:00
2019-08-21 15:51:00 +08:00
## Features
2021-03-23 11:45:40 +08:00
- Browse libraries, series and books via a responsive web UI that works on desktop, tablets and phones
- Organize your library with collections and read lists
- Edit metadata for your series and books
- Import embedded metadata automatically
- Webreader with multiple reading modes
2022-03-03 14:18:33 +08:00
- Manage multiple users, with per-library access control, age restrictions, and labels restrictions
2021-03-23 11:45:40 +08:00
- Offers a REST API, many community tools and scripts can interact with Komga
2024-08-30 16:23:55 +08:00
- OPDS v1 and v2 support
- Kobo Sync with your Kobo eReader
2022-02-08 15:46:07 +08:00
- Download book files, whole series, or read lists
- Duplicate files detection
- Duplicate pages detection and removal
- Import books from outside your libraries directly into your series folder
- Import ComicRack `cbl` read lists
2019-08-21 15:51:00 +08:00
2023-09-27 09:26:27 +08:00
## Installation
2019-08-23 20:14:34 +08:00
2023-09-27 09:26:27 +08:00
Refer to the [website](https://komga.org/docs/category/installation) for instructions.
2019-08-23 20:14:34 +08:00
2020-02-24 17:21:25 +08:00
## Documentation
2019-08-23 20:14:34 +08:00
2020-02-24 17:21:25 +08:00
Head over to our [website](https://komga.org) for more information.
2020-02-25 14:57:07 +08:00
## Develop in Komga
Check the [development guidelines](./DEVELOPING.md).
## Translation
[![Translation status](https://hosted.weblate.org/widgets/komga/-/webui/horizontal-auto.svg)](https://hosted.weblate.org/engage/komga/)
## Sponsors
2021-03-23 11:45:40 +08:00
[![Jetbrains_logo](./.github/readme-images/sponsors-jetbrains.png)](https://www.jetbrains.com/?from=Komga)
2019-08-21 15:51:00 +08:00
## Credits
2019-08-22 08:43:30 +08:00
The Komga icon is based on an icon made by [Freepik](https://www.freepik.com/home) from www.flaticon.com