127 lines
No EOL
6.2 KiB
Markdown
127 lines
No EOL
6.2 KiB
Markdown
# [<img src="/Logo/kavita.svg" width="32" alt="">]() Kavita
|
|
<div align="center">
|
|
|
|
|
|
|
|
Kavita is a fast, feature rich, cross platform reading server. Built with a focus for manga,
|
|
and the goal of being a full solution for all your reading needs. Setup your own server and share
|
|
your reading collection with your friends and family!
|
|
|
|
[](https://github.com/Kareadita/Kavita/releases)
|
|
[](https://github.com/Kareadita/Kavita/blob/master/LICENSE)
|
|
[](https://github.com/Kareadita/Kavita/releases)
|
|
[](https://hub.docker.com/r/kizaing/kavita/)
|
|
[](https://sonarcloud.io/dashboard?id=Kareadita_Kavita)
|
|
[](https://sonarcloud.io/dashboard?id=Kareadita_Kavita)
|
|
[](https://paypal.me/majora2007?locale.x=en_US)
|
|
[](#backers)
|
|
[](#sponsors)
|
|
</div>
|
|
|
|
# Demo
|
|
[https://demo.kavitareader.com/](https://demo.kavitareader.com/)
|
|
|
|
```
|
|
Username: demouser
|
|
Password: Demouser64
|
|
```
|
|
|
|
## Features
|
|
- [x] Serve up Manga/Webtoons/Comics (cbr, cbz, zip/rar, 7zip, raw images) and Books (epub, mobi, azw, djvu, pdf)
|
|
- [x] First class responsive readers that work great on any device (phone, tablet, desktop)
|
|
- [x] Provide a dark theme for web app
|
|
- [ ] Provide hooks into metadata providers to fetch metadata for Comics, Manga, and Books
|
|
- [ ] Metadata should allow for collections, want to read integration from 3rd party services, genres.
|
|
- [x] Ability to manage users, access, and ratings
|
|
- [ ] Ability to sync ratings and reviews to external services
|
|
- [x] Fully Accessible with active accessibility audits
|
|
- [x] Dedicated webtoon reader
|
|
- [ ] And so much [more...](https://github.com/Kareadita/Kavita/projects)
|
|
|
|
## Support
|
|
[](https://www.reddit.com/r/KavitaManga/)
|
|
[](https://discord.gg/eczRp9eeem)
|
|
[](https://github.com/Kareadita/Kavita/issues)
|
|
|
|
## Setup
|
|
### Non-Docker
|
|
- Unzip the archive for your target OS
|
|
- Place in a directory that is writable. If on windows, do not place in Program Files, this folder is protected by Windows.
|
|
- Linux users must ensure the directory is writable by Kavita (chown +x Kavita)
|
|
- Run Kavita
|
|
- If you are updating, do not copy appsettings.json from the new version over. It will override your TokenKey and you will have to reauthenticate on your devices.
|
|
|
|
### Docker
|
|
Running your Kavita server in docker is super easy! Barely an inconvenience. You can run it with this command:
|
|
|
|
```
|
|
docker run --name kavita -p 5000:5000 \
|
|
-v /your/manga/directory:/manga \
|
|
-v /kavita/data/directory:/kavita/data \
|
|
--restart unless-stopped \
|
|
-d kizaing/kavita:latest
|
|
```
|
|
|
|
You can also run it via the docker-compose file:
|
|
|
|
```
|
|
version: '3.9'
|
|
services:
|
|
kavita:
|
|
image: kizaing/kavita:latest
|
|
volumes:
|
|
- ./manga:/manga
|
|
- ./data:/kavita/data
|
|
ports:
|
|
- "5000:5000"
|
|
restart: unless-stopped
|
|
```
|
|
|
|
**Note: Kavita is under heavy development and is being updated all the time, so the tag for current builds is `:nightly`. The `:latest` tag will be the latest stable release. There is also the `:alpine` tag if you want a smaller image, but it is only available for x64 systems.**
|
|
|
|
## Feature Requests
|
|
Got a great idea? Throw it up on the FeatHub or vote on another idea. Please check the [Project Board](https://github.com/Kareadita/Kavita/projects) first for a list of planned features.
|
|
|
|
[](https://feathub.com/Kareadita/Kavita)
|
|
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute. [Contribute](CONTRIBUTING.md).
|
|
<a href="https://github.com/Kareadita/Kavita/graphs/contributors"><img src="https://opencollective.com/kavita/contributors.svg?width=890&button=false" /></a>
|
|
|
|
|
|
## Donate
|
|
If you like Kavita, have gotten good use out of it or feel like you want to say thanks with a few bucks, feel free to donate. Money will go towards
|
|
expenses related to Kavita. You can back us through OpenCollective.
|
|
|
|
[](https://paypal.me/majora2007?locale.x=en_US)
|
|
|
|
## Backers
|
|
|
|
Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/Kavita#backer)
|
|
|
|
<img src="https://opencollective.com/Kavita/backers.svg?width=890"></a>
|
|
|
|
## Sponsors
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/Kavita#sponsor)
|
|
|
|
<img src="https://opencollective.com/Kavita/sponsors.svg?width=890"></a>
|
|
|
|
## Mega Sponsors
|
|
<img src="https://opencollective.com/Kavita/tiers/mega-sponsor.svg?width=890"></a>
|
|
|
|
## JetBrains
|
|
Thank you to [<img src="/Logo/jetbrains.svg" alt="" width="32"> JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools.
|
|
|
|
* [<img src="/Logo/rider.svg" alt="" width="32"> Rider](http://www.jetbrains.com/rider/)
|
|
* [<img src="/Logo/dottrace.svg" alt="" width="32"> dotTrace](http://www.jetbrains.com/dottrace/)
|
|
|
|
## Sentry
|
|
Thank you to [<img src="/Logo/sentry.svg" alt="" width="32"> Sentry](https://sentry.io/welcome/) for providing us with free license to their software.
|
|
|
|
### License
|
|
|
|
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
|
* Copyright 2010-2021 |