mirror of
https://github.com/beshu-tech/deltaglider.git
synced 2026-03-18 15:23:52 +01:00
7a2ed16ee7
Created extensive documentation for the DG_MAX_RATIO parameter, which controls delta compression efficiency thresholds. New Documentation: - docs/DG_MAX_RATIO.md (526 lines) * Complete explanation of how DG_MAX_RATIO works * Real-world scenarios and use cases * Decision trees for choosing optimal values * Industry-specific recommendations * Monitoring and tuning strategies * Advanced usage patterns * Comprehensive FAQ Updates to Existing Documentation: - README.md: Added link to DG_MAX_RATIO guide with tip callout - CLAUDE.md: Added detailed DG_MAX_RATIO explanation and guide link - Dockerfile: Added inline comments explaining DG_MAX_RATIO tuning - docs/sdk/getting-started.md: Added DG_MAX_RATIO guide reference Key Topics Covered: - What DG_MAX_RATIO does and why it exists - How to choose the right value (0.2-0.7 range) - Real-world scenarios (nightly builds, major versions, etc.) - Industry-specific use cases (SaaS, mobile apps, backups, etc.) - Configuration examples (Docker, SDK, CLI) - Monitoring and optimization strategies - Advanced usage patterns (dynamic ratios, A/B testing) - FAQ addressing common questions Examples Included: - Conservative (0.2-0.3): For dissimilar files or expensive storage - Default (0.5): Balanced approach for most use cases - Permissive (0.6-0.7): For very similar files or cheap storage Value Proposition: - Helps users optimize compression for their specific use case - Prevents inefficient delta compression - Provides data-driven tuning methodology - Reduces support questions about compression behavior 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
100 lines
3.4 KiB
Docker
100 lines
3.4 KiB
Docker
# Multi-stage build for deltaglider
|
|
ARG PYTHON_VERSION=3.12-slim
|
|
ARG UV_VERSION=0.5.13
|
|
|
|
# Builder stage - install UV and dependencies
|
|
FROM ghcr.io/astral-sh/uv:$UV_VERSION AS uv
|
|
FROM python:${PYTHON_VERSION} AS builder
|
|
|
|
# Copy UV from the UV image
|
|
COPY --from=uv /uv /usr/local/bin/uv
|
|
ENV UV_SYSTEM_PYTHON=1
|
|
|
|
WORKDIR /build
|
|
|
|
# Copy dependency files first for better caching
|
|
COPY pyproject.toml ./
|
|
COPY README.md ./
|
|
|
|
# Install dependencies with UV caching
|
|
RUN --mount=type=cache,target=/root/.cache/uv \
|
|
uv pip install --compile-bytecode .
|
|
|
|
# Copy source code
|
|
COPY src ./src
|
|
|
|
# Install the package (force reinstall to ensure it's properly installed)
|
|
RUN --mount=type=cache,target=/root/.cache/uv \
|
|
uv pip install --compile-bytecode --no-deps --force-reinstall .
|
|
|
|
# Runtime stage - minimal image
|
|
FROM python:${PYTHON_VERSION}
|
|
|
|
# Skip man pages and docs to speed up builds
|
|
RUN mkdir -p /etc/dpkg/dpkg.cfg.d && \
|
|
echo 'path-exclude /usr/share/doc/*' > /etc/dpkg/dpkg.cfg.d/01_nodoc && \
|
|
echo 'path-exclude /usr/share/man/*' >> /etc/dpkg/dpkg.cfg.d/01_nodoc && \
|
|
echo 'path-exclude /usr/share/groff/*' >> /etc/dpkg/dpkg.cfg.d/01_nodoc && \
|
|
echo 'path-exclude /usr/share/info/*' >> /etc/dpkg/dpkg.cfg.d/01_nodoc && \
|
|
echo 'path-exclude /usr/share/lintian/*' >> /etc/dpkg/dpkg.cfg.d/01_nodoc && \
|
|
echo 'path-exclude /usr/share/linda/*' >> /etc/dpkg/dpkg.cfg.d/01_nodoc
|
|
|
|
# Install xdelta3 (now much faster without man pages)
|
|
RUN apt-get update && \
|
|
apt-get install -y --no-install-recommends xdelta3 && \
|
|
apt-get clean && \
|
|
rm -rf /var/lib/apt/lists/*
|
|
|
|
# Create non-root user
|
|
RUN useradd -m -u 1000 -s /bin/bash deltaglider
|
|
|
|
# Copy installed packages from builder
|
|
COPY --from=builder /usr/local/lib/python3.12/site-packages /usr/local/lib/python3.12/site-packages
|
|
COPY --from=builder /usr/local/bin/deltaglider /usr/local/bin/deltaglider
|
|
|
|
# Set up working directory
|
|
WORKDIR /app
|
|
RUN chown -R deltaglider:deltaglider /app
|
|
|
|
# Create cache directory with proper permissions
|
|
RUN mkdir -p /tmp/.deltaglider && \
|
|
chown -R deltaglider:deltaglider /tmp/.deltaglider
|
|
|
|
USER deltaglider
|
|
|
|
# Health check
|
|
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
|
|
CMD deltaglider --help || exit 1
|
|
|
|
# Environment variables (all optional, can be overridden at runtime)
|
|
# Logging
|
|
ENV DG_LOG_LEVEL=INFO
|
|
|
|
# Performance & Compression
|
|
# DG_MAX_RATIO: Maximum delta/file ratio (0.0-1.0)
|
|
# Default 0.5 means: only use delta if delta_size ≤ 50% of original_size
|
|
# Lower (0.2-0.3) = more conservative, only high-quality compression
|
|
# Higher (0.6-0.7) = more permissive, accept modest savings
|
|
# See docs/DG_MAX_RATIO.md for complete tuning guide
|
|
ENV DG_MAX_RATIO=0.5
|
|
|
|
# Cache Configuration
|
|
ENV DG_CACHE_BACKEND=filesystem
|
|
ENV DG_CACHE_MEMORY_SIZE_MB=100
|
|
# ENV DG_CACHE_ENCRYPTION_KEY=<base64-key> # Optional: Set for cross-process cache sharing
|
|
|
|
# AWS Configuration (override at runtime)
|
|
# ENV AWS_ENDPOINT_URL=https://s3.amazonaws.com
|
|
# ENV AWS_ACCESS_KEY_ID=<your-key>
|
|
# ENV AWS_SECRET_ACCESS_KEY=<your-secret>
|
|
# ENV AWS_DEFAULT_REGION=us-east-1
|
|
|
|
# Labels
|
|
LABEL org.opencontainers.image.title="DeltaGlider" \
|
|
org.opencontainers.image.description="Delta-aware S3 file storage wrapper with encryption" \
|
|
org.opencontainers.image.version="5.0.3" \
|
|
org.opencontainers.image.authors="Beshu Limited" \
|
|
org.opencontainers.image.source="https://github.com/beshu-tech/deltaglider"
|
|
|
|
ENTRYPOINT ["deltaglider"]
|
|
CMD ["--help"] |