New service : Kavita, a self hosted ebook library

[fdbuck0]

Homepage of the project: https://www.kavitareader.com

Installation with docker compose: https://wiki.kavitareader.com/installation/docker/dockerhub/

Looks like a nice addition to this project :)

Frederik

[jackspiering]

Hi Frederik,

We will have a look at it soon. We will report back to you with a status update!

[fdbuck0]

Hi, I did some experimenting, and came up with this. Works for me ;)

/config/serve.json :

{
  "TCP": {
    "443": {
      "HTTPS": true
    }
  },
  "Web": {
    "${TS_CERT_DOMAIN}:443": {
      "Handlers": {
        "/": {
          "Proxy": "http://127.0.0.1:5000"
        }
      }
    }
  }
}

.env :

#version=1.0
#url=https://github.com/2Tiny2Scale/tailscale-docker-sidecar-configs
#COMPOSE_PROJECT_NAME= // only use in multiple deployments on the same infra
SERVICE=kavita
IMAGE_URL=jvmilazz0/kavita:latest
SERVICEPORT=5000
TS_AUTHKEY=xxxxxxxxxxxxxxxxx
DNS_SERVER=9.9.9.9

docker-compose.yml :

services:
# Make sure you have updated/checked the .env file with the correct variables. 
# All the ${ xx } need to be defined there.
  # Tailscale Sidecar Configuration
  tailscale:
    image: tailscale/tailscale:latest # Image to be used
    container_name: tailscale-${SERVICE} # Name for local container management
    hostname: ${SERVICE} # Name used within your Tailscale environment
    environment:
      - TS_AUTHKEY=${TS_AUTHKEY}
      - TS_STATE_DIR=/var/lib/tailscale
      - TS_SERVE_CONFIG=/config/serve.json # Tailsacale Serve configuration to expose the web interface on your local Tailnet - remove this line if not required
      - TS_USERSPACE=false
      - TS_ENABLE_HEALTH_CHECK=true              # Enable healthcheck endpoint: "/healthz"
      - TS_LOCAL_ADDR_PORT=127.0.0.1:41234       # The <addr>:<port> for the healthz endpoint
      - TS_ACCEPT_DNS=true # Uncomment when using MagicDNS
    volumes:
      - ${PWD}/config:/config # Config folder used to store Tailscale files - you may need to change the path
      - ${PWD}/ts/state:/var/lib/tailscale # Tailscale requirement - you may need to change the path
    devices:
      - /dev/net/tun:/dev/net/tun # Network configuration for Tailscale to work
    cap_add:
      - net_admin # Tailscale requirement
    #ports:
    #  - 0.0.0.0:${SERVICEPORT}:${SERVICEPORT} # Binding port ${SERVICE}PORT to the local network - may be removed if only exposure to your Tailnet is required
    # If any DNS issues arise, use your preferred DNS provider by uncommenting the config below
    #dns: 
    #  - ${DNS_SERVER}
    healthcheck:
      test: ["CMD", "wget", "--spider", "-q", "http://127.0.0.1:41234/healthz"] # Check Tailscale has a Tailnet IP and is operational
      interval: 1m # How often to perform the check
      timeout: 10s # Time to wait for the check to succeed
      retries: 3 # Number of retries before marking as unhealthy
      start_period: 10s # Time to wait before starting health checks
    restart: always

  # ${SERVICE}
  application:
    image: ${IMAGE_URL} # Image to be used
    network_mode: service:tailscale # Sidecar configuration to route ${SERVICE} through Tailscale
    container_name: app-${SERVICE} # Name for local container management
    environment:
      # Optional: put your config options customization here. Examples:
      # ND_LOGLEVEL: debug
      - PUID=1000
      - PGID=1000
      - TZ=Europe/Amsterdam
    volumes:
      - ${PWD}/${SERVICE}-data/config:/kavita/config
      - /path/to/manga:/manga
      - /path/to/comics:/comics
      - /path/to/books:/books
    depends_on:
      tailscale:
        condition: service_healthy
    # healthcheck:
    #   test: ["CMD", "pgrep", "-f", "${SERVICE}"] # Check if ${SERVICE} process is running
    #   interval: 1m # How often to perform the check
    #   timeout: 10s # Time to wait for the check to succeed
    #   retries: 3 # Number of retries before marking as unhealthy
    #   start_period: 30s # Time to wait before starting health checks
    restart: always

[jackspiering]

Hi @fdbuck0 , thank you for you patience. I will create a PR for this service soon. Please feel free to create a PR for Kavita yourself.

[jackspiering]

@fdbuck0 , thank you very much for waiting, please have a look at #158. You will be able to see the new Kavita service after it's reviewed and merged.