APT Proxy

A lightweight APT Cache Proxy - just less 10MB in size!

Overview

APT Proxy is a lightweight, high-performance caching proxy for package managers. It accelerates package downloads by caching frequently used packages locally, dramatically reducing download times for subsequent installations. Whether you're managing multiple servers, building Docker images, or working in bandwidth-constrained environments, APT Proxy helps you save time and bandwidth.

Key Features

Multi-Distribution Support: Works with APT (Ubuntu/Debian), YUM (CentOS), and APK (Alpine Linux)
Lightweight: Binary size is just less 10MB - minimal resource footprint
Smart Mirror Selection: Automatically benchmarks and selects the fastest mirror
Docker-Ready: Seamlessly integrates with Docker containers and build processes
apt-cacher-ng Friendly: Compatible with most apt-cacher-ng usage patterns (note: advanced features such as the Import/Maint web UI, full acng.conf syntax, and cross-distro deb deduplication are not implemented)
Zero Configuration: Works out of the box with sensible defaults
Observability: Built-in health checks, Prometheus metrics, structured logging, and optional OpenTelemetry tracing
Cache Management: REST API for cache statistics, purging, and cleanup, with API-key authentication and per-IP rate limiting

Supported Platforms

Pre-built binaries (tar.gz on the releases page and .deb / .rpm / .apk packages):

Linux: amd64 (x86_64), 386 (i386), arm64 (ARMv8), arm (ARMv6 and ARMv7)
macOS: amd64 (Intel) and arm64 (Apple Silicon)

Multi-arch Docker images (soulteary/apt-proxy and ghcr.io/soulteary/apt-proxy):

linux/amd64
linux/arm64
linux/arm/v7

Note: ARMv6 is shipped as a standalone binary only; there is no ARMv6 Docker image.

Quick Start

Installation

Download the latest release for your platform from the releases page, or use Docker:

docker pull soulteary/apt-proxy

Running APT Proxy

Simply run the binary - no configuration required:

./apt-proxy

You should see output similar to:

2024/01/15 10:30:00 INF starting apt-proxy version=1.0.0 listen=0.0.0.0:3142 protocol=http
2024/01/15 10:30:01 INF Starting benchmark for mirrors
2024/01/15 10:30:01 INF Finished benchmarking mirrors
2024/01/15 10:30:01 INF using fastest mirror mirror=https://mirrors.company.ltd/ubuntu/
2024/01/15 10:30:01 INF server started successfully

The proxy is now running and ready to cache packages. By default, it listens on 0.0.0.0:3142 and automatically selects the fastest mirror for your location.

Usage Examples

Ubuntu / Debian

Configure your system to use the proxy by setting the http_proxy environment variable:

# Update package lists (first run will download and cache)
http_proxy=http://your-domain-or-ip-address:3142 \
  apt-get -o pkgProblemResolver=true -o Acquire::http=true update

# Install packages (subsequent installs will use cached packages)
http_proxy=http://your-domain-or-ip-address:3142 \
  apt-get -o pkgProblemResolver=true -o Acquire::http=true install vim -y

Tip: For convenience, you can export the proxy settings in your shell:

export http_proxy=http://your-domain-or-ip-address:3142
apt-get update
apt-get install vim -y

After the first download, all subsequent package operations will be significantly faster as packages are served from the local cache.

CentOS

APT Proxy works with YUM repositories. Configure your CentOS system to use the proxy:

For CentOS 7:

# Configure repository to use proxy
cat /etc/yum.repos.d/CentOS-Base.repo | \
  sed -e s/mirrorlist.*$// \
      -e s/#baseurl/baseurl/ \
      -e s#http://mirror.centos.org#http://your-domain-or-ip-address:3142# | \
  tee /etc/yum.repos.d/CentOS-Base.repo

# Verify configuration
yum update

For CentOS 8:

# Update all CentOS repositories to use proxy
sed -i -e "s#mirror.centos.org#http://your-domain-or-ip-address:3142#g" \
       -e "s/#baseurl/baseurl/" \
       -e "s#\$releasever/#8-stream/#" \
       /etc/yum.repos.d/CentOS-*

# Verify configuration
yum update

Alpine Linux

Configure Alpine's APK package manager to use the proxy:

# Update repositories to use proxy
cat /etc/apk/repositories | \
  sed -e s#https://.*.alpinelinux.org#http://your-domain-or-ip-address:3142# | \
  tee /etc/apk/repositories

# Verify configuration
apk update

Advanced Configuration

Distributions and Mirrors Config (distributions.yaml)

You can maintain distributions and mirror lists via an external YAML file without changing code or recompiling.

Config file search order (when not specified):

./config/distributions.yaml
./distributions.yaml
/etc/apt-proxy/distributions.yaml
~/.config/apt-proxy/distributions.yaml

You can also set the path explicitly via --distributions-config or APT_PROXY_DISTRIBUTIONS_CONFIG.

Example config/distributions.yaml:

distributions:
  - id: ubuntu
    name: Ubuntu
    type: 1
    url_pattern: "/ubuntu/(.+)$"
    benchmark_url: "dists/noble/main/binary-amd64/Release"
    geo_mirror_api: "http://mirrors.ubuntu.com/mirrors.txt"
    cache_rules:
      - pattern: "deb$"
        cache_control: "max-age=100000"
        rewrite: true
    mirrors:
      official:
        - "mirrors.tuna.tsinghua.edu.cn/ubuntu/"
        - "mirrors.ustc.edu.cn/ubuntu/"
      custom:
        - "mirrors.163.com/ubuntu/"
    aliases:
      tsinghua: "mirrors.tuna.tsinghua.edu.cn/ubuntu/"
      ustc: "mirrors.ustc.edu.cn/ubuntu/"

After editing the file, send SIGHUP or call POST /api/mirrors/refresh to hot-reload without restart.

Field reference:

id — unique identifier used in URL paths (/<id>/...).
name — human-readable display name.
type — integer distro type: 1 Ubuntu, 2 UbuntuPorts, 3 Debian, 4 CentOS, 5 Alpine. 0 is reserved for "all".
url_pattern — regex matched against the request path; the captured group is appended to the upstream mirror.
benchmark_url — relative path probed during mirror benchmarking.
geo_mirror_api — optional URL returning a list of geo-located mirrors (Ubuntu-style mirrors.txt).
cache_rules[] — per-pattern cache directives. cache_control overrides response Cache-Control for matched paths (only applied to 200/404 responses); rewrite: true enables URL rewriting for that pattern.
mirrors.official / mirrors.custom — mirror host lists. Aliases of the form cn:<name> are auto-generated from each mirror's host (e.g. mirrors.tuna.tsinghua.edu.cn → cn:tsinghua).
aliases — explicit name-to-mirror mapping that overrides/augments the auto-generated aliases.

Adding or editing a distribution: Add or edit an entry under distributions with id, name, type, url_pattern, benchmark_url, cache_rules, mirrors, and aliases. The repo includes an example at config/distributions.yaml that you can extend.

Custom Mirror Selection

By default, APT Proxy automatically benchmarks available mirrors and selects the fastest one. However, you can specify custom mirrors if needed.

Using Full URLs:

# Cache multiple distributions
./apt-proxy \
  --ubuntu=https://mirrors.tuna.tsinghua.edu.cn/ubuntu/ \
  --debian=https://mirrors.tuna.tsinghua.edu.cn/debian/

# Cache only Ubuntu packages (reduces memory usage)
./apt-proxy --mode=ubuntu --ubuntu=https://mirrors.tuna.tsinghua.edu.cn/ubuntu/

# Cache only Debian packages
./apt-proxy --mode=debian --debian=https://mirrors.tuna.tsinghua.edu.cn/debian/

Using Mirror Shortcuts:

For convenience, you can use predefined shortcuts instead of full URLs:

./apt-proxy --ubuntu=cn:tsinghua --debian=cn:163

Available Shortcuts:

cn:tsinghua - Tsinghua University Mirror
cn:ustc - USTC Mirror
cn:163 - NetEase Mirror
cn:aliyun - Alibaba Cloud Mirror
cn:huaweicloud - Huawei Cloud Mirror
cn:tencent - Tencent Cloud Mirror

Example output:

2024/01/15 10:55:26 INF starting apt-proxy version=1.0.0
2024/01/15 10:55:26 INF using specified debian mirror mirror=https://mirrors.163.com/debian/
2024/01/15 10:55:26 INF using specified ubuntu mirror mirror=https://mirrors.tuna.tsinghua.edu.cn/ubuntu/
2024/01/15 10:55:26 INF proxy listening on 0.0.0.0:3142
2024/01/15 10:55:26 INF server started successfully

Docker Integration

Running APT Proxy in Docker

Deploy APT Proxy as a Docker container:

docker run -d \
  --name=apt-proxy \
  -p 3142:3142 \
  -v apt-proxy-cache:/app/.aptcache \
  soulteary/apt-proxy

The -v apt-proxy-cache:/app/.aptcache option persists the cache across container restarts.

Using APT Proxy in Docker Builds

Accelerate package installation in your Docker containers:

# Start a container (Ubuntu or Debian)
docker run --rm -it ubuntu

# Inside the container, use the proxy
http_proxy=http://host.docker.internal:3142 \
  apt-get -o Debug::pkgProblemResolver=true -o Acquire::http=true update

http_proxy=http://host.docker.internal:3142 \
  apt-get -o Debug::pkgProblemResolver=true -o Acquire::http=true install vim -y

Note: host.docker.internal works on Docker Desktop. For Linux, use the host's IP address or configure Docker networking appropriately.

Docker Compose Example

See the examples directory for complete Docker Compose configurations. It contains four self-contained subdirectories: basic/ (minimal deployment), specify-mirrors/ (pin upstream mirrors), s3-otterio/ (cache offloaded to an S3-compatible bucket, using OtterIO — an Apache-2.0 fork of MinIO) and config-template/ (fully-commented apt-proxy.yaml reference).

Configuration Options

View all available options:

./apt-proxy -h

Available Options: Flags are grouped by topic below; each flag has a 1:1 environment-variable and YAML equivalent (see Environment Variables and YAML Configuration File).

Option	Description	Default
`-host`	Network interface to bind to	`0.0.0.0`
`-port`	Port to listen on	`3142`
`-mode`	Distribution mode: `all`, `ubuntu`, `ubuntu-ports`, `debian`, `centos`, `alpine`	`all`
`-cachedir`	Directory to store cached packages	`./.aptcache`
`-ubuntu`	Ubuntu mirror URL or shortcut	(auto-select)
`-ubuntu-ports`	Ubuntu Ports mirror URL or shortcut	(auto-select)
`-debian`	Debian mirror URL or shortcut	(auto-select)
`-centos`	CentOS mirror URL or shortcut	(auto-select)
`-alpine`	Alpine mirror URL or shortcut	(auto-select)
`-distributions-config`	Path to distributions/mirrors YAML (distributions.yaml)	(optional)
`-cache-max-size`	Maximum cache size in GB (0 to disable)	`10`
`-cache-ttl`	Cache TTL in hours (0 to disable)	`168` (7 days)
`-cache-cleanup-interval`	Cache cleanup interval in minutes	`60`
`-tls`	Enable TLS/HTTPS (requires `-tls-cert` and `-tls-key`)	`false`
`-tls-cert`	Path to TLS certificate file
`-tls-key`	Path to TLS private key file
`-api-key`	API key for protected endpoints (auto-enables auth when set)
`-enable-api-auth`	Explicitly enable/disable API authentication middleware	`false` (auto `true` when `-api-key` is set)
`-api-rate-limit`	API requests per IP per minute (`0` to disable)	`60`
`-trusted-proxies`	Comma-separated CIDRs whose `X-Forwarded-For` is honored by rate limiter and auth
`-upstream-keep-alive`	Enable HTTP keep-alive to upstream mirrors	`true`
`-storage-backend`	Cache storage backend: `disk` or `s3` (see S3 Storage Backend)	`disk`
`-s3-endpoint`	S3 endpoint host[:port] (required when backend is `s3`)
`-s3-region`	S3 region (required for AWS S3, ignored by most MinIO services)
`-s3-bucket`	S3 bucket name (must already exist)
`-s3-prefix`	S3 object key prefix	`apt-proxy/`
`-s3-access-key` / `-s3-secret-key`	S3 IAM credentials
`-s3-session-token`	Optional STS session token
`-s3-use-ssl`	Use HTTPS to talk to the S3 endpoint	`true`
`-s3-use-path-style`	Force path-style URLs (needed for MinIO/Ceph)	`false`
`-s3-inline-max-mb`	In-memory write threshold in MiB before spilling to TempDir	`32`
`-s3-temp-dir`	Directory for spilled writes (default `os.TempDir()`)
`-config`	Path to YAML configuration file
`-debug`	Enable verbose debug logging (also dumps request headers/body to logs)	`false`

Example with Custom Configuration:

./apt-proxy \
  --host=0.0.0.0 \
  --port=3142 \
  --cachedir=/var/cache/apt-proxy \
  --mode=ubuntu \
  --ubuntu=cn:tsinghua \
  --cache-max-size=20 \
  --debug

Environment Variables

Every CLI flag has an equivalent environment variable. Plus a few extras for logging and tracing.

Server / Mode

Variable	Equivalent flag	Description
`APT_PROXY_HOST`	`-host`	Network interface to bind to
`APT_PROXY_PORT`	`-port`	Port to listen on
`APT_PROXY_MODE`	`-mode`	Distribution mode (`all`/`ubuntu`/`ubuntu-ports`/`debian`/`centos`/`alpine`)
`APT_PROXY_DEBUG`	`-debug`	Enable verbose debug logging
`APT_PROXY_UBUNTU`	`-ubuntu`	Ubuntu mirror URL or shortcut
`APT_PROXY_UBUNTU_PORTS`	`-ubuntu-ports`	Ubuntu Ports mirror URL or shortcut
`APT_PROXY_DEBIAN`	`-debian`	Debian mirror URL or shortcut
`APT_PROXY_CENTOS`	`-centos`	CentOS mirror URL or shortcut
`APT_PROXY_ALPINE`	`-alpine`	Alpine mirror URL or shortcut
`APT_PROXY_UPSTREAM_KEEP_ALIVE`	`-upstream-keep-alive`	HTTP keep-alive to upstream mirrors

Cache

Variable	Equivalent flag	Description
`APT_PROXY_CACHEDIR`	`-cachedir`	Cache directory
`APT_PROXY_CACHE_MAX_SIZE`	`-cache-max-size`	Maximum cache size in GB (`0` disables)
`APT_PROXY_CACHE_TTL`	`-cache-ttl`	Cache TTL in hours (`0` disables)
`APT_PROXY_CACHE_CLEANUP_INTERVAL`	`-cache-cleanup-interval`	Cache cleanup interval in minutes (`0` disables)

TLS

Variable	Equivalent flag	Description
`APT_PROXY_TLS_ENABLED`	`-tls`	Enable TLS/HTTPS
`APT_PROXY_TLS_CERT`	`-tls-cert`	Path to TLS certificate
`APT_PROXY_TLS_KEY`	`-tls-key`	Path to TLS private key

Security (API)

Variable	Equivalent flag	Description
`APT_PROXY_API_KEY`	`-api-key`	API key for protected endpoints
`APT_PROXY_ENABLE_API_AUTH`	`-enable-api-auth`	Explicit toggle for API auth middleware
`APT_PROXY_API_RATE_LIMIT_PER_MINUTE`	`-api-rate-limit`	API requests per IP per minute (`0` disables)
`APT_PROXY_TRUSTED_PROXIES`	`-trusted-proxies`	Comma-separated trusted proxy CIDRs

Storage Backend

Variable	Equivalent flag	Description
`APT_PROXY_STORAGE_BACKEND`	`-storage-backend`	`disk` (default) or `s3`
`APT_PROXY_S3_ENDPOINT`	`-s3-endpoint`	S3 endpoint host[:port]
`APT_PROXY_S3_REGION`	`-s3-region`	S3 region
`APT_PROXY_S3_BUCKET`	`-s3-bucket`	S3 bucket name
`APT_PROXY_S3_PREFIX`	`-s3-prefix`	S3 object key prefix
`APT_PROXY_S3_ACCESS_KEY`	`-s3-access-key`	S3 access key ID
`APT_PROXY_S3_SECRET_KEY`	`-s3-secret-key`	S3 secret access key
`APT_PROXY_S3_SESSION_TOKEN`	`-s3-session-token`	Optional STS session token
`APT_PROXY_S3_USE_SSL`	`-s3-use-ssl`	Use HTTPS to talk to the S3 endpoint
`APT_PROXY_S3_USE_PATH_STYLE`	`-s3-use-path-style`	Force path-style URLs
`APT_PROXY_S3_INLINE_MAX_MB`	`-s3-inline-max-mb`	Memory write threshold in MiB before spilling
`APT_PROXY_S3_TEMP_DIR`	`-s3-temp-dir`	Directory for spilled writes

Configuration files

Variable	Equivalent flag	Description
`APT_PROXY_CONFIG_FILE`	`-config`	Path to `apt-proxy.yaml`
`APT_PROXY_DISTRIBUTIONS_CONFIG`	`-distributions-config`	Path to `distributions.yaml`

Logging & Tracing (no CLI equivalent)

Variable	Description
`APT_PROXY_LOG_LEVEL`	Log level: `debug` / `info` / `warn` / `error`. `--debug` forces `debug`.
`APT_PROXY_LOG_FORMAT`	Log format: `json` / `console` / `auto` (auto-detects based on TTY).
`LOG_LEVEL`	Legacy alias; only used when `APT_PROXY_LOG_LEVEL` is unset.
`LOG_FORMAT`	Legacy alias; only used when `APT_PROXY_LOG_FORMAT` is unset.
`OTEL_EXPORTER_OTLP_ENDPOINT`	When set, enables OpenTelemetry tracing and exports spans via OTLP to this endpoint. Spans are flushed on graceful shutdown.

Configuration Priority: CLI flags > Environment variables > Config file > Default values

YAML Configuration File

APT Proxy supports YAML configuration files for more complex setups. Create a file named apt-proxy.yaml:

server:
  host: 0.0.0.0
  port: 3142
  debug: false

cache:
  dir: /var/cache/apt-proxy
  max_size_gb: 20
  ttl_hours: 168
  cleanup_interval_min: 60

# Optional: switch the cache to an S3-compatible object store.
# When backend is "disk" (the default) only the cache.dir field above matters.
storage:
  backend: disk        # "disk" (default) or "s3"
  s3:
    endpoint: ""
    region: ""
    bucket: ""
    prefix: apt-proxy/
    access_key: ""
    secret_key: ""
    use_ssl: true
    use_path_style: false
    inline_max_mb: 32
    temp_dir: ""

mirrors:
  ubuntu: cn:tsinghua
  ubuntu_ports: ""
  debian: cn:ustc
  centos: ""
  alpine: ""

tls:
  enabled: false
  cert_file: /etc/ssl/certs/apt-proxy.crt
  key_file: /etc/ssl/private/apt-proxy.key

security:
  api_key: ${APT_PROXY_API_KEY}        # supports ${VAR} and ${VAR:-default} expansion
  enable_api_auth: true
  api_rate_limit_per_minute: 60        # 0 disables; default 60
  trusted_proxies:                     # CIDRs whose X-Forwarded-For is trusted
    - 10.0.0.0/8
    - 192.168.0.0/16

mode: all

# Upstream transport
upstream_keep_alive: true

# Optional: external distributions/mirrors config (hot-reloadable)
distributions_config: ./config/distributions.yaml

Environment variable expansion in YAML: values support ${VAR} and ${VAR:-default} forms. Bare $VAR is not expanded. An undefined ${VAR} is left as-is (instead of becoming empty) so that typos surface loudly.

Note: the cache section uses the human-friendly fields shown above (dir, max_size_gb, ttl_hours, cleanup_interval_min); the raw byte/duration fields (max_size, ttl, cleanup_interval) are internal representations and are not read from YAML.

Config file search paths (in order):

Path specified via -config flag or APT_PROXY_CONFIG_FILE environment variable
./apt-proxy.yaml (current directory)
/etc/apt-proxy/apt-proxy.yaml
~/.config/apt-proxy/apt-proxy.yaml
~/.apt-proxy.yaml

Cache Capacity and Eviction

The cache supports a size limit configured via max_size_gb (YAML), --cache-max-size (CLI), or APT_PROXY_CACHE_MAX_SIZE (environment variable). When the total cache size exceeds this limit, the proxy automatically evicts the least recently used (LRU) files until the total size is within the limit. Eviction runs both when storing new items and during periodic cleanup.

Set a positive value (e.g. 20 for 20 GB) to enable the capacity limit and LRU eviction.
Set to 0 to disable the size limit; no size-based eviction is performed.

After a process restart, the LRU order is approximated using file modification time until new accesses update it.

S3 Storage Backend

Instead of writing the cache to a local directory, apt-proxy can keep every cached body/header inside any S3-compatible object store. This is useful when several apt-proxy instances need to share a cache pool, when the cache must outlive ephemeral compute (e.g. Kubernetes nodes), or when local disk is simply too small.

Switch the backend with --storage-backend=s3 (or APT_PROXY_STORAGE_BACKEND=s3, or storage.backend: s3 in YAML). The minimum config is endpoint, bucket, access_key, and secret_key; everything else falls back to safe defaults.

YAML example:

storage:
  backend: s3
  s3:
    endpoint: minio.example.com:9000     # host[:port], no scheme
    region: us-east-1                    # required for AWS S3, ignored by most MinIO services
    bucket: apt-proxy
    prefix: apt-proxy/                   # optional, default "apt-proxy/"
    access_key: ${APT_PROXY_S3_ACCESS_KEY}
    secret_key: ${APT_PROXY_S3_SECRET_KEY}
    use_ssl: true
    use_path_style: false                # MinIO/Ceph need true; AWS/R2/B2 use false
    inline_max_mb: 32                    # writes <= 32 MiB stay in memory; larger spill to TempDir
                                         # NOTE: per-write cap; RAM peak ~= concurrency * inline_max_mb (see "Resource sizing")
    temp_dir: ""                         # empty = os.TempDir()

ENV example (suitable for Kubernetes / Docker):

APT_PROXY_STORAGE_BACKEND=s3
APT_PROXY_S3_ENDPOINT=minio:9000
APT_PROXY_S3_BUCKET=apt-proxy
APT_PROXY_S3_ACCESS_KEY=...
APT_PROXY_S3_SECRET_KEY=...
APT_PROXY_S3_USE_SSL=false
APT_PROXY_S3_USE_PATH_STYLE=true

CLI example:

./apt-proxy \
  --storage-backend=s3 \
  --s3-endpoint=s3.us-west-2.amazonaws.com \
  --s3-region=us-west-2 \
  --s3-bucket=apt-proxy \
  --s3-access-key=$AWS_ACCESS_KEY_ID \
  --s3-secret-key=$AWS_SECRET_ACCESS_KEY

Compatibility matrix:

Provider	`endpoint`	`use_ssl`	`use_path_style`	Notes
AWS S3	`s3.<region>.amazonaws.com`	`true`	`false`	Set `region` explicitly
MinIO	`minio.local:9000` / `<host>:9000`	varies	`true`	path-style is required
OtterIO	`otterio:9000` / `<host>:9000`	varies	`true`	Apache-2.0 fork of MinIO; same config
Ceph RGW	`rgw.example.com`	varies	`true`	path-style is required
Cloudflare R2	`<account>.r2.cloudflarestorage.com`	`true`	`false`	Region must be `auto`
Backblaze B2	`s3.<region>.backblazeb2.com`	`true`	`false`	App keys with read+write to bucket
Aliyun OSS	`oss-cn-hangzhou.aliyuncs.com`	`true`	`false`	RAM keys with `oss:GetObject/PutObject`
Tencent COS	`cos.ap-shanghai.myqcloud.com`	`true`	`false`	Use SecretId/SecretKey
Garage / SeaweedFS	depends	varies	`true`	Treat as MinIO-flavoured

Operational notes:

The bucket must already exist. apt-proxy performs a BucketExists check on startup and refuses to launch on misconfiguration so you don't discover the problem on the first cache miss.
Health check (/healthz) reports the storage backend status: a HeadBucket round-trip for s3, os.Stat for disk.
In-memory metadata LRU (8192 entries by default) absorbs the chatty Header() access pattern of httpcache-kit so most requests cost a single S3 GET, not two.
Writes use a "smart" upload strategy: bodies up to inline_max_mb stay in RAM and PUT in one shot; anything bigger spills to a temp file before PutObject. Tune inline_max_mb based on your typical package size.
cache.dir / --cachedir / APT_PROXY_CACHEDIR are ignored when the S3 backend is active. Only TLS cert/key files still need a local path. Setting a non-default cache.dir while storage.backend=s3 triggers a startup warning so the override is observable rather than silently dropped.

Resource sizing & capacity planning (S3 backend):

The defaults are tuned for low-to-medium concurrency; under heavy concurrent ingest you must size memory and disk accordingly, otherwise you risk OOM kills or temp_dir exhaustion.

Memory peak ≈ concurrent_uploads × inline_max_mb. The inline_max_mb threshold (default 32) is a per-write cap, not a global one. Every in-flight write that has not yet crossed the threshold holds its own buffer in RAM. Worst-case examples:

Concurrent uploads inline_max_mb Approx. RSS headroom needed

50 32 ~1.6 GiB

200 32 ~6.4 GiB

1000 32 ~32 GiB

1000 4 ~4 GiB

If your typical APT objects are small (Packages.gz, .deb < 4 MiB), drop inline_max_mb to 4–8 to keep the inline path while shrinking the worst case. If you regularly serve large packages (kernels, CUDA, LLVM toolchains

100 MiB), keep inline_max_mb modest and accept the spill — disk is cheaper than RAM at the p99.
Disk water-mark on temp_dir. Anything larger than inline_max_mb spills exactly once to temp_dir (default os.TempDir(), i.e. /tmp) and is removed on Close(). The transient peak is roughly concurrent_large_uploads × max_object_size. On Kubernetes this matters in three places:
1. /tmp typically lives on the container's writable layer or an emptyDir volume — both count against ephemeral-storage limits. Set resources.requests.ephemeral-storage and resources.limits.ephemeral-storage explicitly, or the kubelet may evict the pod under disk pressure with no warning.
2. Prefer mounting an emptyDir (optionally medium: Memory only if you have RAM to spare) at the path you point temp_dir to. This decouples the spill water-mark from the image layer and gives you a predictable ceiling.
3. Read-only root filesystems must still grant write access to temp_dir (typical pattern: readOnlyRootFilesystem: true + a dedicated emptyDir mount).

Sample Pod sizing (200 concurrent connections, mixed APT traffic with occasional > 32 MiB packages):

resources:
  requests:
    memory: "1Gi"           # baseline + LRU + small-object inline path
    cpu: "500m"
    ephemeral-storage: "2Gi"
  limits:
    memory: "8Gi"           # 200 × 32 MiB inline worst case + headroom
    cpu: "2"
    ephemeral-storage: "8Gi"
volumeMounts:
  - name: spill
    mountPath: /var/cache/apt-proxy/tmp
volumes:
  - name: spill
    emptyDir:
      sizeLimit: 8Gi

And in apt-proxy.yaml:

storage:
  backend: s3
  s3:
    inline_max_mb: 8         # smaller cap → lower memory peak
    temp_dir: /var/cache/apt-proxy/tmp

Rule of thumb. Pick inline_max_mb so that expected_concurrency × inline_max_mb fits comfortably inside your memory limit (not request), and size temp_dir to at least expected_concurrency × p99_package_size. When in doubt, lower inline_max_mb first: the disk path is well-tested and the only cost is one extra write→read round-trip per large object.

A complete working example (compose stack with OtterIO + auto-provisioned bucket

pre-wired apt-proxy) lives in examples/s3-otterio/.

API Endpoints

APT Proxy provides REST API endpoints for monitoring and management:

Health & Monitoring

Endpoint	Description
`GET /healthz`	Aggregated health check (cache, dependencies)
`GET /livez`	Kubernetes liveness probe (lightweight, no dependencies)
`GET /readyz`	Kubernetes readiness probe (currently shares the same aggregator as `/healthz`)
`GET /version`	Version information (also available via `X-Version` response header on every response)
`GET /metrics`	Prometheus metrics
`ALL /_/ping`, `ALL /_/ping/*`	Cheap reachability probe; always returns `pong`
`GET /`	Internal status page (HTML) showing routes, mirrors, and cache stats

Cache Management (Protected)

Endpoint	Method	Description
`/api/cache/stats`	GET	Cache statistics (size, hit rate, item count)
`/api/cache/purge`	POST	Purge all cached items
`/api/cache/cleanup`	POST	Remove stale cache entries

Mirror Management (Protected)

Endpoint	Method	Description
`/api/mirrors/refresh`	POST	Reload distributions/mirrors config (distributions.yaml) and refresh mirrors

API Authentication

When an API key is configured, all /api/* endpoints require authentication. Setting --api-key (or APT_PROXY_API_KEY) implicitly enables auth; pass --enable-api-auth=false to force-disable it. Provide the API key using one of these methods:

X-API-Key Header (recommended):

curl -H "X-API-Key: your-api-key" http://localhost:3142/api/cache/stats

Authorization Bearer Token:

curl -H "Authorization: Bearer your-api-key" http://localhost:3142/api/cache/stats

API Rate Limiting

All /api/* endpoints are subject to per-IP rate limiting. The default budget is 60 requests per IP per minute (sliding 1-minute window); set --api-rate-limit=0 to disable. When the limit is exceeded the server responds with HTTP 429 Too Many Requests and a JSON body whose error code is ErrRateLimited.

By default the client IP is taken from RemoteAddr. To honor X-Forwarded-For (e.g. behind nginx, ALB, or a cloud LB), pass the trusted proxy CIDRs via --trusted-proxies=10.0.0.0/8,192.168.0.0/16 (or APT_PROXY_TRUSTED_PROXIES). Only requests originating from those CIDRs will have their X-Forwarded-For parsed; otherwise it is ignored to prevent spoofing.

Response Headers

The server attaches the following headers to every response:

X-Version, X-Build-* — version and build metadata (also available at GET /version).
Standard security headers (e.g. X-Content-Type-Options, X-Frame-Options, Referrer-Policy, Strict-Transport-Security when TLS is on).
X-Cache: HIT / MISS / SKIP on proxy responses (used by the request logger to classify traffic).

Example: Get Cache Statistics (with authentication)

curl -H "X-API-Key: your-api-key" http://localhost:3142/api/cache/stats

Response:

{
  "total_size_bytes": 1073741824,
  "total_size_human": "1.00 GB",
  "item_count": 150,
  "stale_count": 5,
  "hit_count": 1250,
  "miss_count": 150,
  "hit_rate": 0.893
}

Hot Reload

APT Proxy supports hot reloading of distributions and mirror config only (including distributions.yaml) without restart. Changes to the main configuration (e.g. apt-proxy.yaml: server host/port, cache limits, TLS, security, API key) do not hot-reload and require a process restart.

To reload distributions and mirrors:

# Send SIGHUP to reload config and refresh mirrors
kill -HUP $(pgrep apt-proxy)

Or use the API:

curl -X POST http://localhost:3142/api/mirrors/refresh

Both paths are equivalent: they reload distributions.yaml and re-run mirror selection. SIGHUP signals are debounced (consecutive signals within ~500ms are coalesced) and queued (at most one extra reload is scheduled while a reload is in progress), so it is safe to invoke them rapidly from scripts.

Observability

Metrics

The /metrics endpoint exposes Prometheus metrics. Key metrics and suggested alerts:

Metric / area	Description	Suggested alert
`apt_proxy_cache_hits_total` / `apt_proxy_cache_misses_total`	Cache hits and misses	Hit ratio drops sharply
`apt_proxy_cache_size_bytes` / `apt_proxy_cache_items`	Current cache footprint	Cache size near `--cache-max-size` limit
`apt_proxy_cache_evictions_total`	LRU evictions due to size limit	Sustained eviction rate (cache too small)
`apt_proxy_cache_cleanup_duration_seconds`	Periodic cleanup duration	Cleanup taking too long
`apt_proxy_cache_upstream_request_duration_seconds{method,status}`	Upstream request latency by method/status	P99 above threshold
`apt_proxy_cache_upstream_errors_total`	Upstream fetch errors	Error rate spike
Health (`/healthz`, `/readyz`)	Service and dependency health	Probes failing

Exact labels and additional series are emitted by the underlying httpcache-kit; scrape /metrics to enumerate them.

Logging

Logging is structured (JSON or console) and configured purely via environment variables:

APT_PROXY_LOG_LEVEL — debug / info / warn / error (default info). LOG_LEVEL is honored as a legacy fallback.
APT_PROXY_LOG_FORMAT — json / console / auto (default auto, picks console when stdout is a TTY). LOG_FORMAT is honored as a legacy fallback.
--debug / APT_PROXY_DEBUG=true forces debug level and dumps request headers and bodies into access logs — use only for troubleshooting.

Each request log carries request_id, cache (HIT/MISS/SKIP/empty), and the response size. The probe paths /healthz, /livez, and /readyz are excluded from access logs to keep them quiet.

Distributed Tracing (OpenTelemetry)

Set OTEL_EXPORTER_OTLP_ENDPOINT to your OTLP collector (e.g. http://otel-collector:4317) to enable OpenTelemetry tracing. The exporter is wired up automatically; spans are flushed during graceful shutdown. Tracing is disabled when the variable is unset.

Architecture

flowchart LR
    Client[APT Client] --> Proxy[apt-proxy]
    Proxy --> Cache[(Local Cache)]
    Proxy --> Mirror1[Mirror 1]
    Proxy --> Mirror2[Mirror 2]
    
    subgraph aptproxy [apt-proxy internals]
        Handler[Handler] --> Rewriter[URL Rewriter]
        Rewriter --> Benchmark[Mirror Benchmark]
        Handler --> HTTPCache[HTTP Cache]
        Auth[Auth Middleware] --> Handler
    end
    
    subgraph monitoring [Observability]
        Metrics[Prometheus /metrics]
        Health[Health Checks]
        API[Management API]
    end

Request Flow

Client Request: APT client sends package request to apt-proxy
Cache Check: Handler checks if package exists in local cache
Cache Hit: If cached and fresh, return immediately from cache
Cache Miss: Rewrite URL to fastest mirror, fetch from upstream
Store & Respond: Cache response and return to client

Project Structure

apt-proxy/
├── cmd/
│   └── apt-proxy/            # Application entrypoint
│       └── main.go           # Main entry point
├── internal/                 # Private application code
│   ├── api/                  # REST API handlers and middlewares
│   │   ├── auth.go           # API authentication middleware
│   │   ├── cache.go          # Cache management endpoints
│   │   ├── mirrors.go        # Mirror management endpoints
│   │   ├── ratelimit.go      # Per-IP rate limiting middleware
│   │   ├── clientip.go       # Client IP extraction (X-Forwarded-For + trusted proxies)
│   │   └── response.go       # Response utilities
│   ├── benchmarks/           # Mirror benchmarking (sync & async)
│   ├── cli/                  # CLI and daemon management
│   │   ├── cli.go            # Entrypoint, version wiring
│   │   ├── daemon.go         # Server lifecycle, routing, signal handling
│   │   └── health.go         # Custom Fiber health handler (race-safe shutdown)
│   ├── config/               # Configuration management
│   │   ├── config.go         # Configuration structures
│   │   ├── defaults.go       # Default values and env var keys
│   │   ├── loader.go         # Config loading orchestration
│   │   ├── loader_flags.go   # CLI flag parsing
│   │   ├── loader_yaml.go    # YAML loading + ${VAR}/${VAR:-default} expansion
│   │   ├── loader_merge.go   # CLI/ENV/file/defaults merging with explicit-flag tracking
│   │   ├── loader_search.go  # Config file search paths
│   │   └── loader_validate.go# Validation (paths, TLS files, cache writability)
│   ├── distro/               # Distribution definitions and registry
│   │   ├── distro.go         # Common types and utilities
│   │   ├── registry.go       # Built-in distro registry
│   │   ├── loader.go         # distributions.yaml loader and search paths
│   │   ├── rules.go          # Cache rule helpers
│   │   ├── ubuntu.go         # Ubuntu configuration
│   │   ├── ubuntu-ports.go   # Ubuntu Ports configuration
│   │   ├── debian.go         # Debian configuration
│   │   ├── centos.go         # CentOS configuration
│   │   └── alpine.go         # Alpine configuration
│   ├── errors/               # Unified error handling
│   │   └── errors.go         # Error codes and types
│   ├── mirrors/              # Mirror management
│   │   ├── mirrors.go        # Mirror list resolution
│   │   ├── ubuntu.go         # Ubuntu geo-mirror discovery
│   │   └── templates.go      # URL templating helpers
│   ├── proxy/                # Core proxy functionality
│   │   ├── handler.go        # HTTP request handling
│   │   ├── rewriter.go       # URL rewriting
│   │   ├── transport.go      # Upstream HTTP transport (keep-alive, timeouts)
│   │   ├── page.go           # Home page rendering
│   │   └── stats.go          # Statistics
│   ├── state/                # Per-Server runtime state (proxy mode, mirror URLs)
│   └── system/               # System utilities (disk, gc, filesize)
├── tests/                    # Integration tests
│   └── integration/          # End-to-end tests
└── config/, docker/, examples/ # Sample configs, deployment, and runnable examples

Development

Building from Source

git clone https://github.com/soulteary/apt-proxy.git
cd apt-proxy
go build -o apt-proxy ./cmd/apt-proxy

When developing alongside vfs-kit or httpcache-kit, go.mod may use replace directives (e.g. ../kits/httpcache-kit); remove them when using published versions.

Running Tests

# Run all tests with coverage
go test -cover ./...

# Generate detailed coverage report
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Troubleshooting

Debug Mode

Enable debug logging to troubleshoot issues:

./apt-proxy --debug

Debugging Package Operations

For detailed debugging of package manager operations (Ubuntu/Debian):

# Enable verbose debugging
http_proxy=http://192.168.33.1:3142 \
  apt-get -o Debug::pkgProblemResolver=true \
          -o Debug::Acquire::http=true \
          update

http_proxy=http://192.168.33.1:3142 \
  apt-get -o Debug::pkgProblemResolver=true \
          -o Debug::Acquire::http=true \
          install apache2

Common Issues

Issue: Packages not being cached Solution: Ensure the proxy URL is correctly configured and accessible from your client machines.

Issue: Slow first-time downloads Solution: This is expected - the first download populates the cache. Subsequent downloads will be faster.

Issue: Cache directory growing too large Solution: Configure cache limits with --cache-max-size or use the cleanup API endpoint.

License

This project is licensed under the Apache License 2.0.

Acknowledgments

This project builds upon the excellent work of:

lox/apt-proxy - Original APT proxy implementation
lox/httpcache - HTTP caching library (MIT License)
djherbis/stream - Stream handling library (MIT License)
soulteary/vfs-kit - Virtual filesystem library (from rainycape/vfs, Mozilla Public License 2.0)

Support

Issues: GitHub Issues
Discussions: GitHub Discussions

Made with ❤️ by the APT Proxy community

Name		Name	Last commit message	Last commit date
Latest commit History 241 Commits
.github		.github
cmd/apt-proxy		cmd/apt-proxy
config		config
docker		docker
examples		examples
internal		internal
scripts		scripts
tests/integration		tests/integration
.dockerignore		.dockerignore
.gitignore		.gitignore
.golangci.yml		.golangci.yml
.goreleaser.yaml		.goreleaser.yaml
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
README_CN.md		README_CN.md
SECURITY.md		SECURITY.md
go.mod		go.mod
go.sum		go.sum

Concurrent uploads	`inline_max_mb`	Approx. RSS headroom needed
50	`32`	~1.6 GiB
200	`32`	~6.4 GiB
1000	`32`	~32 GiB
1000	`4`	~4 GiB

Folders and files

Latest commit

History

Repository files navigation

APT Proxy

Overview

Key Features

Supported Platforms

Quick Start

Installation

Running APT Proxy

Usage Examples

Ubuntu / Debian

CentOS

Alpine Linux

Advanced Configuration

Distributions and Mirrors Config (distributions.yaml)

Custom Mirror Selection

Docker Integration

Running APT Proxy in Docker

Using APT Proxy in Docker Builds

Docker Compose Example

Configuration Options

Environment Variables

YAML Configuration File

Cache Capacity and Eviction

S3 Storage Backend

API Endpoints

Health & Monitoring

Cache Management (Protected)

Mirror Management (Protected)

API Authentication

API Rate Limiting

Response Headers

Hot Reload

Observability

Metrics

Logging

Distributed Tracing (OpenTelemetry)

Architecture

Request Flow

Project Structure

Development

Building from Source

Running Tests

Contributing

Troubleshooting

Debug Mode

Debugging Package Operations

Common Issues

License

Acknowledgments

Support

About

Topics

Resources

License

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 25

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Packages