sdk/

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: Apache-2.0

Directories

Path Synopsis
Package client connects a host (the Panelarr server, or any program) to source plugins: managed binaries it starts itself, remote plugins it reaches by URL, and in-process plugins for tests.
Package client connects a host (the Panelarr server, or any program) to source plugins: managed binaries it starts itself, remote plugins it reaches by URL, and in-process plugins for tests.
Package conformance checks that a source plugin follows the panelarr.source.v1 protocol.
Package conformance checks that a source plugin follows the panelarr.source.v1 protocol.
examples
static-source command
Command static-source is a minimal source plugin that serves two made-up sources.
Command static-source is a minimal source plugin that serves two made-up sources.
Package httpx gives source plugins HTTP clients that follow the network profiles their host pushes per source (SetNetworkProfile): the proxy (http, https or socks5, with credentials), a challenge solver (FlareSolverr/Byparr), a rate limit (per source or per host), a concurrency cap, the user agent, extra headers, DNS over HTTPS, a cookie jar (its own or shared with other sources) and timeouts.
Package httpx gives source plugins HTTP clients that follow the network profiles their host pushes per source (SetNetworkProfile): the proxy (http, https or socks5, with credentials), a challenge solver (FlareSolverr/Byparr), a rate limit (per source or per host), a concurrency cap, the user agent, extra headers, DNS over HTTPS, a cookie jar (its own or shared with other sources) and timeouts.
Package jobs runs a plugin's background jobs and answers the job calls of the JOBS capability (ListJobs, GetJob, ListJobRuns, GetJobRun, RunJob, CancelJobRun) with the shared panelarr.jobs.v1 model.
Package jobs runs a plugin's background jobs and answers the job calls of the JOBS capability (ListJobs, GetJob, ListJobRuns, GetJobRun, RunJob, CancelJobRun) with the shared panelarr.jobs.v1 model.
Package plugin is the Go SDK for writing source plugins for Panelarr.
Package plugin is the Go SDK for writing source plugins for Panelarr.
Package plugintest provides a made-up source plugin for tests: hosts can run against it, and the SDK's own tests and the example plugin use it.
Package plugintest provides a made-up source plugin for tests: hosts can run against it, and the SDK's own tests and the example plugin use it.
Package settings helps plugins describe and validate their settings with JSON Schema (draft 2020-12), the format Panelarr hosts use to render settings and configuration forms.
Package settings helps plugins describe and validate their settings with JSON Schema (draft 2020-12), the format Panelarr hosts use to render settings and configuration forms.

Jump to

Keyboard shortcuts

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