internal/

directory
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 9, 2026 License: GPL-3.0

Directories

Path Synopsis
api
Package api serves the server's HTTP surface: the REST API under /api/v1 (generated from api/openapi.yaml), the health probes, the metrics and, later, the event stream and the web app.
Package api serves the server's HTTP surface: the REST API under /api/v1 (generated from api/openapi.yaml), the health probes, the metrics and, later, the event stream and the web app.
apigen
Package apigen provides primitives to interact with the openapi HTTP API.
Package apigen provides primitives to interact with the openapi HTTP API.
Package auth authenticates callers (browser sessions and personal API keys), hashes passwords, limits login attempts and decides which scopes a caller holds.
Package auth authenticates callers (browser sessions and personal API keys), hashes passwords, limits login attempts and decides which scopes a caller holds.
Package buildinfo holds values stamped into the binary at build time.
Package buildinfo holds values stamped into the binary at build time.
Package cbz writes and reads comic book archives: a ZIP with the pages stored (not compressed, images already are) as 0001.jpg, 0002.png, … and a ComicInfo.xml that other readers understand.
Package cbz writes and reads comic book archives: a ZIP with the pages stored (not compressed, images already are) as 0001.jpg, 0002.png, … and a ComicInfo.xml that other readers understand.
Package chapters builds each work's unified chapter list.
Package chapters builds each work's unified chapter list.
Package config loads the server's startup settings, *arr-style: from environment variables and command-line flags.
Package config loads the server's startup settings, *arr-style: from environment variables and command-line flags.
Package downloads downloads chapters into the shared library: one file per chapter, stored once for everyone, as a CBZ with ComicInfo.xml, on the default storage.
Package downloads downloads chapters into the shared library: one file per chapter, stored once for everyone, as a CBZ with ComicInfo.xml, on the default storage.
Package events fans server events out to connected clients (the server-sent event stream).
Package events fans server events out to connected clients (the server-sent event stream).
Package imagecache fetches remote images (covers) once and keeps them on disk, so browsers never fetch from metadata or source sites themselves: that would leak users' addresses and referrers, and many sites refuse hotlinking anyway.
Package imagecache fetches remote images (covers) once and keeps them on disk, so browsers never fetch from metadata or source sites themselves: that would leak users' addresses and referrers, and many sites refuse hotlinking anyway.
Package jobs runs the server's named background jobs (plugin sync, cleanups, update checks): on a schedule, at startup or by hand, one run at a time per job, each run recorded with its outcome, counts and notes.
Package jobs runs the server's named background jobs (plugin sync, cleanups, update checks): on a schedule, at startup or by hand, one run at a time per job, each run recorded with its outcome, counts and notes.
Package library manages works and users' libraries.
Package library manages works and users' libraries.
Package limits caps work per key (a source, later a host): how many tasks run at once, and how fast requests go.
Package limits caps work per key (a source, later a host): how many tasks run at once, and how fast requests go.
Package logging builds the server's structured logger.
Package logging builds the server's structured logger.
Package meta connects the server to the Panelarr metadata service, which the library needs: every work is created from one of its entries.
Package meta connects the server to the Panelarr metadata service, which the library needs: every work is created from one of its entries.
metatest
Package metatest runs a fake metadata service for tests: the real gRPC API over cleartext HTTP/2, with keys, providers and entries set by the test.
Package metatest runs a fake metadata service for tests: the real gRPC API over cleartext HTTP/2, with keys, providers and entries set by the test.
Package metrics defines the server's Prometheus metrics.
Package metrics defines the server's Prometheus metrics.
Package network keeps the shared network services admins set up once in Panelarr: challenge solvers and proxies, which network profiles use.
Package network keeps the shared network services admins set up once in Panelarr: challenge solvers and proxies, which network profiles use.
Package plugins hosts source plugins.
Package plugins hosts source plugins.
pluginstest
Package pluginstest serves made-up source plugins for tests over the real wire (gRPC on cleartext HTTP/2).
Package pluginstest serves made-up source plugins for tests over the real wire (gRPC on cleartext HTTP/2).
Package queue runs the server's tasks: one database row per piece of work (match a work, check it for updates, download a chapter).
Package queue runs the server's tasks: one database row per piece of work (match a work, check it for updates, download a chapter).
Package reader serves what the reader needs: a chapter's pages (from the chosen copy's source, through its plugin), the neighbouring chapters, reading progress synced across devices, history, and each user's reader settings and app preferences.
Package reader serves what the reader needs: a chapter's pages (from the chosen copy's source, through its plugin), the neighbouring chapters, reading progress synced across devices, history, and each user's reader settings and app preferences.
Package secret encrypts small secrets (service keys, plugin keys, storage credentials) before they are stored, with AES-256-GCM.
Package secret encrypts small secrets (service keys, plugin keys, storage credentials) before they are stored, with AES-256-GCM.
Package storage stores downloaded chapter files on configurable backends: the local filesystem (which includes mounted network shares) and S3-compatible object storage.
Package storage stores downloaded chapter files on configurable backends: the local filesystem (which includes mounted network shares) and S3-compatible object storage.
Package store is Panelarr's PostgreSQL data layer: a pgx pool, the embedded goose migrations and the sqlc queries in package db.
Package store is Panelarr's PostgreSQL data layer: a pgx pool, the embedded goose migrations and the sqlc queries in package db.
db
storetest
Package storetest gives tests a fresh, migrated PostgreSQL database.
Package storetest gives tests a fresh, migrated PostgreSQL database.
Package textmatch compares titles and names across sources and the metadata catalogue: every site writes a title its own way (case, width, accents, punctuation, word order of names).
Package textmatch compares titles and names across sources and the metadata catalogue: every site writes a title its own way (case, width, accents, punctuation, word order of names).
Package users manages accounts: creating, changing and deleting users, their grants, invites and the first-run setup that creates the admin.
Package users manages accounts: creating, changing and deleting users, their grants, invites and the first-run setup that creates the admin.
Package webui serves the Panelarr web app next to the API, following the web app's embedding contract: files at the root, a single-page fallback to index.html (never for API, feed, asset or probe paths), long caching for content-hashed assets, and the app's security headers.
Package webui serves the Panelarr web app next to the API, following the web app's embedding contract: files at the root, a single-page fallback to index.html (never for API, feed, asset or probe paths), long caching for content-hashed assets, and the app's security headers.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL