Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kavita: Expand the documentation #972

Merged
merged 11 commits into from
Mar 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ CalDAV
CardDAV
Catppuccin
CAVA
CBL
CCleaner
CDTV
CedArctic
Expand Down Expand Up @@ -450,6 +451,7 @@ passwd
passwordless
PCIe
petitboot
Personalisation
phpBB
phpMyAdmin
phpSysInfo
Expand Down Expand Up @@ -738,6 +740,7 @@ webserver
webservers
WebServers
webstack
Webtoons
WebUI
whiptail
WH
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/software.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ description: Overview of ready-to-run DietPi-Software options, cloud & backup se
- [**Snapcast Server - Multi room audio server**](software/media.md#snapcast-server)
- [**Snapcast Client - Multi room audio client**](software/media.md#snapcast-client)
- [**Navidrome - Web interface media streaming server**](software/media.md#navidrome)
- [**Kavita - Open source comics/mangas/ebooks media server**](software/media.md#kavita)
- [**Kavita - Your digital library in one place (manga, comics, and books)**](software/media.md#kavita)

## [Printing Server](software/printing.md)

Expand Down
73 changes: 71 additions & 2 deletions docs/software/media.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ description: Description of DietPi software options related to media systems lik
- [**Snapcast Server - Multi room audio server**](#snapcast-server)
- [**Snapcast Client - Multi room audio client**](#snapcast-client)
- [**Navidrome - Web interface media streaming server**](#navidrome)
- [**Kavita - Open source comics/mangas/ebooks media server**](#kavita)
- [**Kavita - Your digital library in one place (manga, comics, and books)**](#kavita)

??? info "How do I run **DietPi-Software** and install **optimised software** items?"
To install any of the **DietPi optimised software items** listed below run from the command line:
Expand Down Expand Up @@ -1864,7 +1864,76 @@ License: [GPLv3](https://github.com/navidrome/navidrome/blob/master/LICENSE)

## Kavita

T.b.d.
Kavita is a self-hosted library, for comics, manga or books.

![Kavita web interface screenshot](../assets/images/dietpi-software-media-kavita.jpg){: width="600" height="378" loading="lazy"}

A highlight of some of its key features:

- _Versatile Content Support_: Kavita ensures a comprehensive library experience by serving Manga, Webtoons, Comics (`cbr`, `cbz`, `zip`/`rar`/`rar5`, `7zip`, raw images), and ebooks (`epub`, `pdf`).

- _Efficient Organization_ with metadata richness: Kavita has a rich metadata support, enhancing user experience with effective filtering and searching. Users can efficiently organize their reading materials through Collections, Reading Lists (CBL Import), and a _Want to Read feature_, ensuring a well-structured library.

- _Personalisation and Theming_: With support for Dark mode and customizable theming, Kavita allows users to tailor their reading environment according to their preferences for a personalised and visually comfortable experience. It has a responsive interface that works great on any device (phone, tablet, desktop). Dark mode and customizable theming support

=== "Web interface"

The web interface is accessible via port **2036**:

- URL: `http://<your.IP>:2036`

=== "Setup details"

The configuration directory is located at:

```
/opt/kavita/config
```

For comics and ebooks, the following two directories have been prepared.

```
/mnt/dietpi_userdata/comics
/mnt/dietpi_userdata/ebooks
```

Any other directory could be used, as long as `kavita` or `dietpi` users have read and write permissions.

=== "Service control"

Kavita runs as `systemd` service and it can be controlled with the following commands:

```sh
systemctl status kavita
```
fpetru marked this conversation as resolved.
Show resolved Hide resolved

```sh
systemctl start kavita
```

```sh
systemctl stop kavita
```

```sh
systemctl restart kavita
```

=== "Logs"

Kavita runs as systemd service, its logs can be viewed via:

```sh
journalctl -u kavita
```

=== "Update"

Kavita can be updated by simply reinstalling it:

```sh
dietpi-software reinstall 212
```
fpetru marked this conversation as resolved.
Show resolved Hide resolved

***

Expand Down