readme-vars.yml

---

# project information
project_name: kavita
project_url: "https://github.com/Kareadita/Kavita"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/kavita-logo.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is a fast, feature rich, cross platform reading server. Built with a focus for being a full solution for all your reading needs. Setup your own server and share your reading collection with your friends and family!"
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# development version
development_versions: false
development_versions_items:
  - {tag: "latest", desc: "Kavita releases"}
# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Contains all relevant configuration files."}
param_usage_include_ports: true
param_ports:
  - {external_port: "5000", internal_port: "5000", port_desc: "web gui"}
opt_param_usage_include_vols: true
opt_param_volumes:
  - {vol_path: "/data", vol_host_path: "/path/to/data", desc: "Media library containing manga, comics and books."}
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the webui at `<your-ip>:5000`. Follow the setup wizard on initial install.

  The docker cli and compose yml samples provided list a single `/data` folder for the media, however, you can set up multiple mount points if you wish. For instance, you can set up 3 separate mountpoints named `/manga`, `/comics` and `/books`, each mapped to separate folders on host.
# init diagram
init_diagram: |
  "kavita:latest": {
    docker-mods
    base {
      fix-attr +\nlegacy cont-init
    }
    docker-mods -> base
    legacy-services
    custom services
    init-services -> legacy-services
    init-services -> custom services
    custom services -> legacy-services
    legacy-services -> ci-service-check
    init-migrations -> init-adduser
    init-os-end -> init-config
    init-config -> init-config-end
    init-crontab-config -> init-config-end
    init-kavita-config -> init-config-end
    init-config -> init-crontab-config
    init-mods-end -> init-custom-files
    base -> init-envfile
    init-config -> init-kavita-config
    base -> init-migrations
    init-config-end -> init-mods
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-custom-files -> init-services
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-kavita
    svc-kavita -> legacy-services
  }
  Base Images: {
    "baseimage-ubuntu:noble"
  }
  "kavita:latest" <- Base Images
# changelog
changelogs:
  - {date: "10.07.24:", desc: "Rebase to Ubuntu Noble."}
  - {date: "12.08.23:", desc: "Fix app file perms to prevent high uid."}
  - {date: "07.08.23:", desc: "Initial Release."}