Comprehensive Documentation

Documentation

Everything you need to get started with RateLimitShield. From quick setup guides to advanced configuration and API reference.

Documentation

Everything you need to integrate RateLimitShield with your infrastructure

Navigation

Quick Start Guide

Get RateLimitShield running in your environment by configuring Docker daemon or CI/CD pipelines.

1
Configure Docker Daemon (Recommended)

Set up Docker daemon to automatically use RateLimitShield for all pulls. See the Configuration section for detailed instructions.

daemon.json
{
"registry-mirrors": [
"https://public-mirror.ratelimitshield.io"
]
}

2
Configure CI/CD (Alternative)

Update your CI/CD configuration files to use registry mirrors:

GitHub Actions / GitLab CI
# GitHub Actions
- name: Configure Docker Registry
run: echo "DOCKER_REGISTRY=public-mirror.ratelimitshield.io" >> $GITHUB_ENV
# GitLab CI
variables:
DOCKER_REGISTRY: public-mirror.ratelimitshield.io

That's it! 🎉

Your Docker pulls now bypass rate limits automatically. No authentication required, works transparently through registry mirrors.