How-to guides

Task-oriented recipes. Each guide assumes a built velodex (see Getting started) and shows the shortest path to one goal.

• Cache packages for CI

  Put velodex between your runners and pypi.org: one environment variable, faster jobs, and one download per wheel instead of hundreds.

• Serve a restricted or air-gapped network

  velodex as the one approved path to PyPI, or as a warm-then-carry partial mirror when there is no path at all.

• Proxy a private upstream

  Point velodex at Artifactory, GitLab, or any other PEP 503 index, with credentials.

• Compose virtual indexes

  Serve several indexes under one URL, give each cached index its own private layer, and chain virtual indexes.

• Publish packages

  Upload distributions with twine or uv publish, authenticated by a shared token.

• Yank and delete packages

  Yank an uploaded release per PEP 592, or delete it outright.

• Use the web UI

  Search packages, browse indexes, read package pages, inspect status, and inspect archives from the browser.

• Monitor usage and cache health

  Read the usage counters, drill down to files, watch for upstream changes, and scrape Prometheus.

• Configure logging

  Choose a level, a format, and a sink: stdout, rotating file, journald, or syslog.

• Cut a release

  What the release pipeline builds, where it publishes, and the one-time setup it needs.