GuideVault

Integrations

Use GuideVault with browsers, OPDS readers, and future local integrations.

GuideVault starts as a self-hosted web reader, with additional integration paths for compatible reading clients, metadata lookup, and future automation.

OP

Authenticated OPDS feed

Use the OPDS feed and generated access key to browse GuideVault content from compatible clients while keeping the feed protected.

API

Versioned API direction

Future public API paths should use a versioned shape such as /api/v1 for JSON integrations and /opds/v1 for OPDS compatibility.

OL

Metadata lookup workflow

Book metadata lookups can help populate guide-style fields such as title, author, publisher, publish year, and ISBN values after review.

Designed for local-first ownership.

Integrations should help you read and maintain your own archive. They should not require your library to be hosted by a third-party service.

OPDS keys

Generate, copy, and rotate access keys from account settings when connecting external readers.

Home network usage

Use http://localhost:5478 on the server or http://<server-ip>:5478 from another LAN device.

Future connectors

Potential connector ideas include LaunchBox metadata workflows, REST-based home automation, and maintenance dashboards.

Security note: Keep OPDS keys private. Treat them like passwords and regenerate them if they are exposed.