diff --git a/README.md b/README.md index 286dbc50e..86b8ae964 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,32 @@ your manga collection with your friends and family! - 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 -- Docker is supported and tested, you can find the image and instructions [here](https://github.com/Kizaing/KavitaDocker). +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. ## Want to help? I am looking for developers with a passion for building the next Plex for Manga, Comics, and Ebooks. I need developers with C#/ASP.NET, Angular 11 or CSS experience.