Documentation

From simpleindex

simpleindex routes simple-API requests by project-name pattern. A TOML file maps each pattern to a local directory of files or an HTTP 302 redirect toward another index. Its scope covers routing and local file serving.

Peryx differences

simpleindex suits route-only deployments. Redirected clients wait on the upstream, while peryx caches upstream responses for machines behind one uplink. peryx also accepts twine uploads. A virtual index merges hosted and cached filenames by default. Set fallback_mode = "private-first" when a hosted project must exclude cached candidates without a route pattern for that project. The team-index tutorial shows a complete configuration and the higher-public-version case.

Configuration mapping

simpleindexperyx
simpleindex ./configuration.tomlperyx serve --config peryx.toml
route source = "http" (302 to an index)a cached layer (fetched, verified, cached)
route source = "path" (local directory)a hosted index, populated by twine upload
per-project route patternsvirtual resolution: hosted layers first, cached last
[server] host / porthost / port

Pitfalls

  • simpleindex's explicit routing can send different projects to different upstreams; peryx's virtual index resolves every project through the same layer order. Model per-project pinning as separate routes (one virtual index per upstream) if you need it.
  • Hosted files must be re-uploaded once; there is no directory-import.
On this page