therobbiedavis / kavita Goto Github PK

This project forked from kareadita/kavita

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.

Home Page: http://www.kavitareader.com

License: GNU General Public License v3.0

C# 97.70% Shell 1.54% Python 0.42% Dockerfile 0.33%

kavita's Introduction

Kavita

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!

Goals

Support

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
Linux users must ensure the directory & kavita.db is writable by Kavita (might require starting server once)
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 first for a list of planned features.

Contributors

This project exists thanks to all the people who contribute. Contribute.

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. Back us through OpenCollective.