Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
source-conformance
command
Command source-conformance checks a running source plugin (or a plugin binary it starts itself) against the panelarr.source.v1 protocol and prints a report.
|
Command source-conformance checks a running source plugin (or a plugin binary it starts itself) against the panelarr.source.v1 protocol and prints a report. |
|
gen
|
|
|
openapi
Package openapi embeds the OpenAPI document generated from the source API protos: the HTTP/JSON mapping of panelarr.source.v1.
|
Package openapi embeds the OpenAPI document generated from the source API protos: the HTTP/JSON mapping of panelarr.source.v1. |
|
sdk
|
|
|
client
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. |
|
conformance
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. |
|
httpx
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. |
|
jobs
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. |
|
plugin
Package plugin is the Go SDK for writing source plugins for Panelarr.
|
Package plugin is the Go SDK for writing source plugins for Panelarr. |
|
plugintest
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. |
|
settings
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. |
Click to show internal directories.
Click to hide internal directories.