Chainguard Container for regclient

regclient is a client interface to OCI conformant registries and content shipped with the OCI Image Layout

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/regclient:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

These images are built on Wolfi, providing regular security updates and a minimal attack surface. Chainguard's images maintain functional parity with the upstream images:

• regctl: A command-line tool for interacting with OCI registries.
• regbot: A tool for automating interactions with OCI registries.
• regsync: A tool for synchronizing content between OCI registries.

Getting Started

regctl - Registry Client CLI

The regctl command provides a CLI interface for interacting with OCI registries. Common usage patterns:

# View help and available commands
docker run --rm cgr.dev/ORGANIZATION/regclient-regctl --help

# Check version
docker run --rm cgr.dev/ORGANIZATION/regclient-regctl version

# Configure registry with disabled TLS (for testing)
docker run --rm cgr.dev/ORGANIZATION/regclient-regctl registry set localhost:5000 --tls disabled --skip-check

# Pull and inspect image configurations
docker run --rm cgr.dev/ORGANIZATION/regclient-regctl image config registry.example.com/image:tag

regbot - Registry Automation Bot

The regbot tool automates registry interactions and can run as a server daemon. Usage examples:

# View help
docker run --rm cgr.dev/ORGANIZATION/regclient-regbot --help

# Check version
docker run --rm cgr.dev/ORGANIZATION/regclient-regbot version

# Run server with configuration file (requires config volume mount)
docker run -d \
  -v /path/to/config.json:/config.json \
  -p 5000:5000 \
  cgr.dev/ORGANIZATION/regclient-regbot server -v=trace -c /config.json

The server typically listens on port 5000 and requires a configuration file specifying registry credentials and automation rules.

regsync - Registry Synchronization

The regsync tool synchronizes content between OCI registries, supporting both one-time sync and continuous monitoring:

# View help
docker run --rm cgr.dev/ORGANIZATION/regclient-regsync --help

# Check version
docker run --rm cgr.dev/ORGANIZATION/regclient-regsync version

# Run one-time sync with configuration
docker run --rm \
  -v /path/to/sync-config.json:/config.json \
  cgr.dev/ORGANIZATION/regclient-regsync once -v=trace -c /config.json

# Run continuous sync server
docker run -d \
  -v /path/to/sync-config.json:/config.json \
  cgr.dev/ORGANIZATION/regclient-regsync server -v=trace -c /config.json

Example sync configuration file:

{
  "version": 1,
  "creds": [{
    "registry": "target-registry:5000",
    "tls": "disabled"
  }],
  "sync": [{
    "type": "image",
    "source": "source-registry.com/image:latest",
    "target": "target-registry:5000/image:latest"
  }]
}

Network Configuration

When running these tools in containerized environments, ensure proper network connectivity:

# Create a custom network for multi-container setups
docker network create regtest

# Run containers with network access
docker run --network regtest --rm cgr.dev/ORGANIZATION/regclient-regsync [commands]

Documentation and Resources

• Documentation
• Usage Guide
• Configuration Examples

What are Chainguard Containers?

Chainguard Containers are minimal container images that are secure by default.

In many cases, the Chainguard Containers tagged as :latest contain only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager. Chainguard Containers are built with Wolfi, our Linux undistro designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a -dev variant.

Although the -dev container image variants have similar security features as their more minimal versions, they feature additional software that is typically not necessary in production environments. We recommend using multi-stage builds to leverage the -dev variants, copying application artifacts into a final minimal container that offers a reduced attack surface that won’t allow package installations or logins.

Learn More

To better understand how to work with Chainguard Containers, please visit Chainguard Academy and Chainguard Courses.

In addition to Containers, Chainguard offers VMs and Libraries. Contact Chainguard to access additional products.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.