Deployment

docker pull ghcr.io/officialunofficial/imgx:latest

docker run -p 8080:8080 \
  -e IMGX_ORIGIN_TYPE=http \
  -e IMGX_ORIGIN_BASE_URL=https://images.example.com \
  ghcr.io/officialunofficial/imgx:latest

docker run -p 8080:8080 \
  -e IMGX_ORIGIN_TYPE=r2 \
  -e IMGX_R2_ENDPOINT=https://<account_id>.r2.cloudflarestorage.com \
  -e IMGX_R2_ACCESS_KEY_ID=your-access-key \
  -e IMGX_R2_SECRET_ACCESS_KEY=your-secret-key \
  -e IMGX_R2_BUCKET_ORIGINALS=originals \
  -e IMGX_R2_BUCKET_VARIANTS=variants \
  ghcr.io/officialunofficial/imgx:latest

docker run -p 8080:8080 --env-file .env ghcr.io/officialunofficial/imgx:latest

docker build -t imgx .
docker run -p 8080:8080 -e IMGX_ORIGIN_BASE_URL=https://images.example.com imgx

services:
  imgx:
    image: ghcr.io/officialunofficial/imgx:latest
    ports:
      - "8080:8080"
    environment:
      IMGX_ORIGIN_TYPE: http
      IMGX_ORIGIN_BASE_URL: https://images.example.com
      IMGX_CACHE_ENABLED: "true"
      IMGX_CACHE_MAX_SIZE_BYTES: "536870912"
      IMGX_SERVER_PORT: "8080"
    healthcheck:
      test: ["CMD", "wget", "--spider", "-q", "http://localhost:8080/health"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 5s
    restart: unless-stopped

brew install vips
cargo build --release -p imgx
./target/release/imgx

apk add vips-dev musl-dev pkgconfig
cargo build --release -p imgx
./target/release/imgx

curl http://localhost:8080/health
# {"status":"ok"}

curl http://localhost:8080/ready
# {"ready":true}

# HELP imgx_requests_total Total number of HTTP requests handled.
# TYPE imgx_requests_total counter
imgx_requests_total 1042

# HELP imgx_cache_hits_total Total number of image-transform cache hits.
# TYPE imgx_cache_hits_total counter
imgx_cache_hits_total 891

# HELP imgx_cache_misses_total Total number of image-transform cache misses.
# TYPE imgx_cache_misses_total counter
imgx_cache_misses_total 151

# HELP imgx_cache_entries Current number of entries in the cache (0 for backends that don't track this).
# TYPE imgx_cache_entries gauge
imgx_cache_entries 148

# HELP imgx_uptime_seconds Seconds since the server started.
# TYPE imgx_uptime_seconds gauge
imgx_uptime_seconds 3600

apiVersion: apps/v1
kind: Deployment
metadata:
  name: imgx
spec:
  replicas: 2
  selector:
    matchLabels:
      app: imgx
  template:
    metadata:
      labels:
        app: imgx
    spec:
      containers:
        - name: imgx
          image: ghcr.io/officialunofficial/imgx:latest
          ports:
            - containerPort: 8080
          env:
            - name: IMGX_ORIGIN_TYPE
              value: "http"
            - name: IMGX_ORIGIN_BASE_URL
              value: "https://images.example.com"
          livenessProbe:
            httpGet:
              path: /health
              port: 8080
            initialDelaySeconds: 5
            periodSeconds: 10
          readinessProbe:
            httpGet:
              path: /ready
              port: 8080
            initialDelaySeconds: 3
            periodSeconds: 5
          resources:
            requests:
              memory: "256Mi"
              cpu: "250m"
            limits:
              memory: "1Gi"
              cpu: "1000m"