Each subdirectory is a self-contained example. Pick the one closest to your
target deployment and read its README.md.
| Example | Runnable | What it shows |
|---|---|---|
basic/ |
docker compose up -d |
Smallest possible deployment; defaults only, in-container cache. |
specify-mirrors/ |
docker compose up -d |
Same as basic/ but pins upstream Ubuntu/Debian mirrors via CLI flags. |
s3-otterio/ |
docker compose up -d |
Production-shaped: cache offloaded to an S3-compatible bucket (OtterIO here). |
custom-distros/ |
docker compose up -d |
Caches Deepin, Armbian and Arch Linux via distributions.yaml — no code change. |
proxmox/ |
docker compose up --build -d |
PBS Client via the original HTTP source or a unique local path; builds the checkout containing the #167 routing fix. |
config-template/ |
not directly runnable | Fully-commented apt-proxy.yaml reference. Copy & trim to your needs. |
- Just kicking the tires on a laptop? Start with
basic/. - Want to pin a fast mirror (e.g. Tsinghua/USTC)? See
specify-mirrors/. - Need durable object storage? See
s3-otterio/— it also works against other S3-compatible providers with their connection settings. Give independently running instances separate bucket prefixes; S3 does not provide shared publication or miss-coordination guarantees. For coordinated shared Unix disk storage and verified by-hash identities, see shared repository cache. - Need a distribution apt-proxy does not ship (Deepin, Armbian, Arch, an
internal archive)? See
custom-distros/. - Need Proxmox repositories under Debian's
/debian/route? Seeproxmox/for the runnable PBS Client setup and v0.19.3+ requirement.config/distributions.yamlalso provides disabled PVE, PBS Server, PBS Client and Ceph Squid examples. - Need to know what every config knob does? Read
config-template/apt-proxy.yaml.
After starting one of the Compose examples, it exposes the proxy on
http://127.0.0.1:3142:
curl -I http://127.0.0.1:3142/healthz
curl -x http://127.0.0.1:3142 \
http://archive.ubuntu.com/ubuntu/dists/noble/Release