3 Grimmory
Codex edited this page 2026-05-22 13:51:48 -07:00

Grimmory

Dashboard Status

This module is live through Grimmory's Komga-compatible API surface. The dashboard uses basic auth credentials for a Grimmory/OPDS/Komga-compatible user.

Primary API surfaces:

/komga/api/v1/libraries
/komga/api/v1/series?page=0&size=1
/komga/api/v1/books?page=0&size=1

Admin Fields

  • Grimmory URL
  • OPDS/Komga Username
  • OPDS/Komga Password
Grimmory URL: https://grimmory.example.com
OPDS/Komga Username: dashboard-user
OPDS/Komga Password: dashboard-password

Use the base URL that the dashboard container can reach.

Important Distinction

Grimmory metadata provider keys, such as Google Books, Hardcover, Comic Vine, and other provider-specific credentials, are for Grimmory fetching book metadata. They are not dashboard integration credentials.

The dashboard needs a username/password that can access the Komga-compatible API.

What The Card Shows

  • Library count.
  • Series count.
  • Book count.
  • Up to eight library rows when returned by Grimmory.

Test From The Docker Host

curl -fsSL \
  -u 'USERNAME:PASSWORD' \
  'https://grimmory.example.com/komga/api/v1/libraries'

Common Problems

  • Pasting a metadata provider API key into the dashboard.
  • OPDS/Komga API not enabled in Grimmory.
  • Wrong username/password for the Komga-compatible surface.
  • Reverse proxy path mismatch.
  • Grimmory base URL includes an extra path segment not expected by /komga/api/v1/....

Sources