How-to Guides¶
How-to guides solve a specific, real-world problem. Unlike tutorials, which guide you through learning a concept step by step, how-to guides assume you already understand the basics and need a reliable recipe for a particular task.
Pick the guide that matches your situation:
Available guides¶
| Guide | Description |
|---|---|
| Client setup (APT / RPM / Maven / PyPI / npm) | Point apt/dnf/zypper/apk, mvn/Gradle, pip/twine, and npm at your Repod instance. |
| Container registry (Docker / OCI) | docker login/push/pull against Repod's built-in OCI registry, plus importing public images. |
| Set up a reverse proxy | Terminate TLS in front of Repod with Nginx, Traefik, or Caddy. |
| Proxy configuration (restricted internet) | Route Repod's outbound calls (CVE feeds, signature updates, imports) through a corporate proxy — worked Squid example included. |
| Import packages from external sources | Mirror APT/RPM packages from public or internal repositories without uploading files manually. |
| Upstream cache (air-gap) | Run a transparent pull-through cache for apt/dnf clients, with an offline seeding workflow for air-gapped sites. |
| Migrate from Sonatype Nexus | Export your Nexus APT repository and import every package into Repod with a bulk upload script. |
| Migrate from JFrog Artifactory | Use the Artifactory REST API and AQL to download packages and re-host them in Repod. |
| Rotate GPG signing keys | Replace your repository signing key safely using a dual-key grace period so client machines are never broken. |
| Back up and restore Repod | Schedule automated backups with backup.sh, copy them offsite, and follow the step-by-step restore procedure. |
| Configure LDAP / Active Directory | Connect Repod to your organisation's LDAP or AD directory so users can log in with their existing credentials. |
| Configuration drift detection | Define a YAML baseline (packages, services, files, permissions) and detect when a machine's real configuration diverges from it. |
How these guides are organised¶
Each guide is self-contained. You can read them in any order. Where a guide depends on another, it links to it explicitly. Code blocks show every command you need to run; admonitions call out warnings, tips, and important notes.
Can't find what you need?
If none of the guides above covers your situation, open an issue on GitHub and describe your use case. Community contributions to the documentation are always welcome.