Hello! Thanks for visiting! mirrorctl is still a young project, and the documentation is still a work-in-progress.
Tutorial

Tutorial

This tutorial shows you how to use mirrorctl to create and manage an apt repository mirror. By the end, you’ll understand how to:

  • sync repositories
  • use snapshots
  • set up a staging-to-production workflow

Prerequisites

Before you begin, make sure you have:

  • mirrorctl installed - See the Install guide.
  • Sufficient disk space - This tutorial only requires a few megabytes of disk space, but full repository mirrors can be quite large (e.g., a full Debian mirror easily exceeds 1TB).
  • A reliable network connection - Initial syncs require a stable network connection.
  • sudo/root access - Needed for installing to system directories (optional if using user directories).
  • Basic command line knowledge - You should be comfortable with terminal commands and basic text editors.

Tutorial Structure

Each section builds on the prior sections, so we recommend following the steps in order:

  1. Your First Mirror - Create a minimal repository mirror
  2. Understand Snapshots - Learn about mirrorctl’s snapshot system
  3. Staging and Production Workflow - Implement safe, tested updates
  4. Expand Your Mirror - Add architectures, suites, and sections
  5. Security Best Practices - Configure PGP and TLS verification
  6. Common Operations - Day-to-day mirror management
  7. Next Steps - Where to go from here

Getting Help

If you run into issues while following this tutorial:

  • Check the Reference Documentation for detailed configuration options
  • Review How-To Guides for specific tasks
  • Use mirrorctl --help or mirrorctl <command> --help for command-line help

Ready to get started? Let’s create your first mirror!