Kavita

Dashboard Status

This module is live. The dashboard reads Kavita auth-key expiry, libraries, server stats, and per-library counts.

Primary API surfaces:

/api/plugin/authkey-expires
/api/Library/libraries
/api/Stats/server/stats

The dashboard also samples library series counts when library-level data is available.

Admin Fields

• Kavita URL
• Auth Key

Recommended Values

Kavita URL: https://kavita.example.com
Auth Key: copied-auth-key

Use the base URL that the dashboard container can reach.

Create A Kavita Auth Key

Kavita recommends Auth Keys for API-style integrations. Auth Keys are user-created keys and are sent with the x-api-key header.

1. Open Kavita.
2. Sign in as the user the dashboard should use.
3. Open the user preferences/dashboard area.
4. Go to the clients or API/Auth Key section.
5. Create an Auth Key for homelab-dashboard.
6. Choose an expiration policy you can maintain.
7. Copy the generated key.

What The Card Shows

• Library count.
• Series, volume, chapter, and file totals when Kavita returns them.
• Auth-key expiration note.
• Up to twelve library rows with item/series, volume, chapter, and scan details when available.

Test From The Docker Host

Check whether the auth key is expired:

curl -fsSL \
  -H 'x-api-key: YOUR_AUTH_KEY' \
  'https://kavita.example.com/api/plugin/authkey-expires'

Check library data:

curl -fsSL \
  -H 'x-api-key: YOUR_AUTH_KEY' \
  'https://kavita.example.com/api/Library/libraries'

Common Problems

• Using an OPDS URL instead of the Auth Key value.
• Using a user token or browser session cookie instead of an Auth Key.
• Expired Auth Key.
• Reverse proxy path mismatch. If Kavita runs under a subpath, include that subpath in Kavita URL.
• Missing stats: some Kavita versions return different field names; verify the raw API response.

Sources

• Kavita API guide: https://wiki.kavitareader.com/guides/api/