Synology: Install Kavita With Portainer

Synology Install Kavita With Portainer

MyĀ previous guide for Kavita involved the use of Task Scheduler. Today Iā€™m offering a recommended and excellent alternative for installing the latest Kavita version via Portainer. 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! Serve up Manga/Webtoons/Comics (cbr, cbz, zip/rar, 7zip, raw images) and Books (epub, pdf) with Kavita. In this step by step guide I will show you how to install Kavita on your Synology NAS using Docker & Portainer.

šŸ’”Note: This guide works perfectly with the latest Kavita v.0.8.4.2Ā release.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

InstallĀ Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • STEP 3

Go toĀ File Station and open the docker folder. Inside the docker folder, create one new folder and name it kavita. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Kavita Synology NAS Set up 1 Portainer

  • STEP 4

Now create two new folders inside the kavita folder that you created at STEP 3 and them config and data. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Kavita Synology NAS Set up 2 Portainer

  • STEP 5

Now create one new folder inside the data folder that you created at STEP 4 and it library. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Kavita Synology NAS Set up 3 Portainer

  • STEP 6

Populate the library folder with your CBR, PDF, EPUB files etc.

Kavita Synology NAS Set up 4 Portainer

  • STEP 7

Log into Portainer using your username and password. On the left sidebar in Portainer, click on StacksĀ thenĀ + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 8

In the Name field type in kavita. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: "3.9"
services:
  kavita:
    image: jvmilazz0/kavita:latest
    container_name: Kavita
    hostname: kavita
    mem_limit: 4g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    ports:
      - 5471:5000
    volumes:
      - /volume1/docker/kavita/config:/kavita/config:rw
      - /volume1/docker/kavita/data:/manga:rw
    restart: on-failure:5

Kavita Synology NAS Set up 5 Portainer new 2024

  • STEP 9

Scroll down on the page until you see a button namedĀ Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

Kavita Synology NAS Set up 6 Portainer

  • STEP 10

If everything goes right, you will see the following message at the top right of your screen: ā€œSuccess Stack successfully deployedā€œ.

Kavita Synology NAS Set up 7 Portainer

  • STEP 11

šŸŸ¢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guidesĀ forget to support my work, or justĀ ignoreĀ STEP 1. Iā€™ve been very honest about this aspect of my work since the beginning: I donā€™t run any ADS, I donā€™t require subscriptions, paid or otherwise, I donā€™t collect IPs, emails, and I donā€™t have any referral links from Amazon or other merchants. I also donā€™t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. Itā€™s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

  • STEP 12

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser andĀ type in http://Synology-ip-address:5471 Create your administrator account. Type in your own Username, Email and Password. Click Register. Follow the instructions in the image below.

Kavita Synology NAS Set up 8 Portainer

  • STEP 13

Type in your own Username and Password that you have previously added at STEP 12 then click Submit. Follow the instructions in the image below.

Kavita Synology NAS Set up 9 Portainer

  • STEP 14

Click on Server settings. Follow the instructions in the image below.

Kavita Synology NAS Set up 10 Portainer

  • STEP 15

At the top right of the page click +Add Library. Follow the instructions in the image below.

Kavita Synology NAS Set up 11 Portainer

  • STEP 16

Name your Library, select your library Type, then click Next. Follow the instructions in the image below.

Kavita Synology NAS Set up 12 Portainer

  • STEP 17

Click + Browse for Media Folders. Follow the instructions in the image below.

Kavita Synology NAS Set up 13 Portainer

  • STEP 18

Click on the first folder marked with the / name. Follow the instructions in the image below.

Kavita Synology NAS Set up 14 Portainer

  • STEP 19

Click manga. Follow the instructions in the image below.

Kavita Synology NAS Set up 15 Portainer

  • STEP 20

Click Share. Follow the instructions in the image below. āš ļøWarning: do not click on the library folder.

Kavita Synology NAS Set up 16 Portainer

  • STEP 21

Click Next. Follow the instructions in the image below.

Kavita Synology NAS Set up 17 Portainer

  • STEP 22

Click Next. Follow the instructions in the image below.

Kavita Synology NAS Set up 18 Portainer

  • STEP 23

Click Save. Follow the instructions in the image below.

Kavita Synology NAS Set up 19 Portainer

  • STEP 24

You will see your entire Library under your library name.

Kavita Synology NAS Set up 20 Portainer

  • STEP 25

Now you can start reading your favorite comics!

Kavita Synology NAS Set up 21 Portainer

You have different options, including Dark theme mode and White theme mode.

Kavita Synology NAS Set up 22 Portainer

Now you can start reading your favorite eBooks!

Kavita Synology NAS Set up 23 Portainer

Everything will be fast and clean.

Kavita Synology NAS Set up 24 Portainer

Enjoy Kavita!

šŸ†˜TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issuesĀ article.

Note: If you want to run the Kavita container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Kavita work via HTTPS, it’s mandatory to activate WebSocket.

Note: Can I run Docker on my Synology NAS?Ā See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find outĀ how to update the Kavita container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Wednesday / January 8th, 2025 at 2:45 AM