muxcore/contracts-indexer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
No description
8 commits 3 branches 1 tag 84 KiB
  • Makefile 100%
Find a file
Exact
zemdregon b7a2a272d1
Some checks are pending
CI / build (push) Waiting to run
Details
CI / lint (push) Waiting to run
Details
CI / test (push) Waiting to run
Details
CI / proto-check (push) Waiting to run
Details
fix(ci): self-hosted runners and drop go test -race (#3) 
Laptop self-hosted runners should not use ubuntu-latest or -race (no gcc/CGO).
2026-08-10 11:40:31 -05:00
.github/workflows fix(ci): self-hosted runners and drop go test -race (#3) 2026-08-10 11:40:31 -05:00
muxcore/indexer/v1 feat: add absolute episode number to indexer SearchRequest 2026-07-21 19:39:39 -05:00
proto/muxcore/indexer/v1 feat: add absolute episode number to indexer SearchRequest 2026-07-21 19:39:39 -05:00
.dockerignore Initial commit 2026-07-03 12:03:00 -05:00
.gitignore Initial commit 2026-07-03 12:03:00 -05:00
CHANGELOG.md docs: add CHANGELOG/COMPATIBILITY and refresh README 2026-08-09 00:17:34 -05:00
COMPATIBILITY.md docs: add CHANGELOG/COMPATIBILITY and refresh README 2026-08-09 00:17:34 -05:00
go.mod Initial commit 2026-07-03 12:03:00 -05:00
go.sum Initial commit 2026-07-03 12:03:00 -05:00
LICENSE docs: refresh README and add LICENSE 2026-07-22 19:09:19 -05:00
Makefile Initial commit 2026-07-03 12:03:00 -05:00
muxcore.json Initial commit 2026-07-03 12:03:00 -05:00
README.md docs: add CHANGELOG/COMPATIBILITY and refresh README 2026-08-09 00:17:34 -05:00

README.md

contracts-indexer

Protobuf/gRPC contract interfaces for search indexer modules in MuxCore.

Proto Service

  • IndexerService (proto/muxcore/indexer/v1/indexer.proto)
    • Search — search for media releases across configured indexers
    • GetCapabilities — discover indexer search features and supported categories
    • ListIndexers — enumerate configured indexers with their status

SearchRequest notes

  • TV: episode=0 with season>0 means season-pack search (no Exx in query)
  • absolute — anime absolute-number field; indexers may ignore it while still matching an absolute token in query

Version

v0.1.0 — see CHANGELOG.md and COMPATIBILITY.md.

Go import

Generated stubs: github.com/Muxcore-Media/contracts-indexer/muxcore/indexer/v1

Implementing Modules

Any module advertising capability indexer may implement this service. Valid shapes:

  • Single-site — one tracker or API (e.g. a Torznab endpoint or native site module)
  • Aggregator — one module that wraps many configured sites (e.g. Prowlarr) and returns results with distinct indexer_name / indexer_id

Callers such as media-automation discover all indexer modules and may fan out Search in parallel; aggregators are optional, not required hubs.

Known / planned implementers

  • indexer-piratebay — single-site The Pirate Bay (Apibay-compatible JSON)
  • indexer-prowlarr — Prowlarr-backed aggregator (planned; repo not published)