Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
bindery
command
|
|
|
internal
|
|
|
api
Package api contains the HTTP handlers served under /api/v1 by the chi router.
|
Package api contains the HTTP handlers served under /api/v1 by the chi router. |
|
auth
Package auth implements password hashing, signed session cookies, the composite auth middleware (cookie OR API key OR local-bypass), and the small helpers those require.
|
Package auth implements password hashing, signed session cookies, the composite auth middleware (cookie OR API key OR local-bypass), and the small helpers those require. |
|
calibre
Package calibre wraps Calibre's `calibredb` command-line utility so the importer can mirror Bindery's library into a user-configured Calibre library.
|
Package calibre wraps Calibre's `calibredb` command-line utility so the importer can mirror Bindery's library into a user-configured Calibre library. |
|
config
Package config loads Bindery's runtime configuration from environment variables with sensible defaults.
|
Package config loads Bindery's runtime configuration from environment variables with sensible defaults. |
|
db
Package db contains the SQLite connection bootstrap, embedded migrations, and per-resource repository types backing the rest of Bindery.
|
Package db contains the SQLite connection bootstrap, embedded migrations, and per-resource repository types backing the rest of Bindery. |
|
downloader
Package downloader provides a unified interface for dispatching download requests to different download clients (SABnzbd, Transmission, qBittorrent).
|
Package downloader provides a unified interface for dispatching download requests to different download clients (SABnzbd, Transmission, qBittorrent). |
|
downloader/qbittorrent
Package qbittorrent provides a client for the qBittorrent WebUI API v2, used to submit magnet/torrent URLs and poll status for torrent downloads.
|
Package qbittorrent provides a client for the qBittorrent WebUI API v2, used to submit magnet/torrent URLs and poll status for torrent downloads. |
|
downloader/sabnzbd
Package sabnzbd provides a client for the SABnzbd JSON API, used to submit NZB URLs and poll queue/history for Usenet downloads.
|
Package sabnzbd provides a client for the SABnzbd JSON API, used to submit NZB URLs and poll queue/history for Usenet downloads. |
|
downloader/transmission
Package transmission provides a client for the Transmission BitTorrent daemon RPC API, used to submit magnet/torrent URLs and poll status for torrent downloads.
|
Package transmission provides a client for the Transmission BitTorrent daemon RPC API, used to submit magnet/torrent URLs and poll status for torrent downloads. |
|
httpsec
Package httpsec provides outbound-URL validation to prevent SSRF attacks.
|
Package httpsec provides outbound-URL validation to prevent SSRF attacks. |
|
importer
Package importer moves completed downloads into the configured library directory using a configurable naming template, and reconciles pre-existing library files against the tracked book database.
|
Package importer moves completed downloads into the configured library directory using a configurable naming template, and reconciles pre-existing library files against the tracked book database. |
|
indexer
Package indexer coordinates book searches across multiple Newznab/Torznab indexers, filters and ranks the returned releases, and exposes a release- name parser shared by the filter pipeline and the import path.
|
Package indexer coordinates book searches across multiple Newznab/Torznab indexers, filters and ranks the returned releases, and exposes a release- name parser shared by the filter pipeline and the import path. |
|
indexer/newznab
Package newznab provides a client for Newznab- and Torznab-compatible indexers used for book search.
|
Package newznab provides a client for Newznab- and Torznab-compatible indexers used for book search. |
|
logbuf
Package logbuf provides an in-process ring buffer for slog records so the UI can surface recent log entries without requiring shell access.
|
Package logbuf provides an in-process ring buffer for slog records so the UI can surface recent log entries without requiring shell access. |
|
metadata
Package metadata aggregates book and author data from multiple public sources (OpenLibrary, Google Books, Hardcover) behind a unified interface.
|
Package metadata aggregates book and author data from multiple public sources (OpenLibrary, Google Books, Hardcover) behind a unified interface. |
|
metadata/audnex
Package audnex provides a read-only client for api.audnex.us, a public JSON wrapper around Audible's catalogue.
|
Package audnex provides a read-only client for api.audnex.us, a public JSON wrapper around Audible's catalogue. |
|
metadata/dnb
Package dnb provides a read-only client for the Deutsche Nationalbibliothek (DNB) via its public SRU endpoint.
|
Package dnb provides a read-only client for the Deutsche Nationalbibliothek (DNB) via its public SRU endpoint. |
|
metadata/googlebooks
Package googlebooks provides a read-only client for the Google Books API, used as a metadata enricher for author and book details.
|
Package googlebooks provides a read-only client for the Google Books API, used as a metadata enricher for author and book details. |
|
metadata/hardcover
Package hardcover provides a read-only GraphQL client for hardcover.app, used as a metadata enricher for community ratings and series data.
|
Package hardcover provides a read-only GraphQL client for hardcover.app, used as a metadata enricher for community ratings and series data. |
|
metadata/openlibrary
Package openlibrary provides the primary book metadata client.
|
Package openlibrary provides the primary book metadata client. |
|
migrate
Package migrate bulk-imports authors and related records into Bindery from external sources — a Readarr SQLite DB or a plain CSV of names.
|
Package migrate bulk-imports authors and related records into Bindery from external sources — a Readarr SQLite DB or a plain CSV of names. |
|
models
Package models defines the domain types shared across the API, database, scheduler, and indexer layers.
|
Package models defines the domain types shared across the API, database, scheduler, and indexer layers. |
|
notifier
Package notifier dispatches webhook notifications for grab, import, failure, and health events to user-configured HTTP endpoints.
|
Package notifier dispatches webhook notifications for grab, import, failure, and health events to user-configured HTTP endpoints. |
|
opds
Package opds builds OPDS 1.2 / Atom 1.0 catalogue feeds from Bindery's authors / books / series tables.
|
Package opds builds OPDS 1.2 / Atom 1.0 catalogue feeds from Bindery's authors / books / series tables. |
|
recommender
Package recommender implements Bindery's content-based book recommendation engine.
|
Package recommender implements Bindery's content-based book recommendation engine. |
|
scheduler
Package scheduler runs Bindery's periodic background jobs (wanted-book search, download-status polling, metadata refresh, library rescan) via robfig/cron.
|
Package scheduler runs Bindery's periodic background jobs (wanted-book search, download-status polling, metadata refresh, library rescan) via robfig/cron. |
|
webui
Package webui bundles the compiled React frontend assets into the Go binary via go:embed so Bindery ships as a single executable.
|
Package webui bundles the compiled React frontend assets into the Go binary via go:embed so Bindery ships as a single executable. |
Click to show internal directories.
Click to hide internal directories.