How to Install Kavita on Your Synology NAS with Docker

09/01/2023

Added Folder Structure

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. Set up your own server and share your reading collection with your friends and family!

Code Source: GitHub Demo: Here Website: Here

Skip to Docker Run Code / Skip to Compose & Portainer Code

Features

Homepage: Quickly resume your reading from your homepage, get to your reading lists and collections.
Browse your Manga, Comics, and Books: See all your series, properly named in one place.
Search: Get to your manga as fast as you can type.
Metadata: Fully supports all fields from ComicInfo.xml (and EPUB) to provide filtering on metadata.

Install Docker

Before we start, please ensure you have Docker installed. This can be installed through the Synology Package Center.

Create the Docker Folder

We now need to create the Kavita Docker folder. Head into File Station and open the Docker folder. Select Create, choose Create folder and name it kavita. (see demonstration)

Create the Scheduled Task

We will now head into Control Panel > Task Scheduler > Create > Scheduled Task and click User-defined script. (see demonstration)

Configure the Scheduled Task

In the window that appears, insert the following:

In the General tab, In the Task field, enter Kavita. From the User list, select root. Uncheck the Enabled option.

In the Schedule tab, Select Run on the following date (make sure It’s today’s date). Now select Do not repeat.

In the Task Settings tab, under Notification, You can choose to turn this on, otherwise skip this. Now copy-paste the following code into the Run command area. Now click OK.

docker run -d --name=kavita \
-p 8685:5000 \
-e PUID=1026 \
-e PGID=100 \
-v /volume1/docker/kavita:/kavita/config \
-v /volume1/data/media/books:/manga \
-v /volume1/data/media/comics:/comics \
-v /volume1/data/media/manga:/manga \
--restart always \
kizaing/kavita

Important: Remember to update the PUID, PGID and directories to match your own.

Accept the warning prompt

When the below warning appears, press OK.

Run the Scheduled Task

You will now see your list of tasks. Select Kavita, now press Run.

When asked to run, press Yes.

Your app is now Installed

The installation process has now finished. Give it a few seconds to appear in your Docker list.

Open your browser and enter the link to your new container http://synologyip:8685.

Enter your login details to set up your new account.

Add your Library folders to get started.

Folder Structure

For Kavita to show your comics, you must not have them in your main comic folder (root). Instead, inside your comic (root) folder have the series name such as Batman. Inside this folder, have your Batman comics.

Kavita requires that each series be in its folder and that no files are at root level of the library.

Library Root
  ┖── Series Name
      ┖── Series Name.cbz

Docker Compose and Portainer

If you would prefer to install with Docker Compose or Portainer, use the following code. You can also view a demonstration here.

version: '3.3'
services:
    kavita:
        container_name: kavita
        ports:
            - '8685:5000'
        environment:
            - PUID=1026
            - PGID=100
        volumes:
            - '/volume1/docker/kavita:/kavita/config'
            - '/volume1/data/media/books:/manga'
            - '/volume1/data/media/comics:/comics'
            - '/volume1/data/media/manga:/manga'
        restart: always
        image: kizaing/kavita

More Guides:

Actual AdGuard airsonic Audiobookshelf autobrr Bitcoin Calibre-Web Cleanarr Composerize Crypto DailyTxT deemix Deluge Emby Ethereum Euterpe FileBot FilePizza FileZilla Flame Focalboard FreshRSS Grafana Grocy Heimdall Homarr Home Assistant Homebridge Jackett Jellyfin Jellyseerr Joplin Kavita Komga LanguageTool LibreOffice Lidarr Mealie MediaGoblin Medusa Memegen Minecraft Minecraft Bedrock MQTT MusicBrainz MyMediaForAlexa Navidrome Node-RED NZBGet NZBHydra Ombi Overseerr PaperlessNGX Pashword Password Cards Petio Pi-Hole Picard Plex Portainer PostgreSQL Prowlarr PUID & PGID pwndrop Radarr Radicale Readarr ruTorrent SABnzbd SearX Seed Phrase Shiori Sonarr SpeedTest Stash Storm Tailscale TasmoAdmin Tautulli Theia Trilium TubeSync Unpackerr Uptime Kuma Vaultwarden Watchtower WebPDF Whisparr Wordle YouTubeDL

---