📦 staticreg

A tool to generate a static website from an OCI registry that supports the /v2/_catalog endpoint.

• 📦 staticreg
  • Features
  • Install staticreg
  • Run staticreg
    • Generate a static website staticreg
    • Serve the website directly
    • Run with Docker
  • Install on Kubernetes
  • Contributing

Features

✅ Images list page
✅ Image tags list page
✅ Static website or HTTP webserver with cache

Install staticreg

If you need, you can run staticreg in your Container runtime or Kubernetes cluster, please see the sections below.

However, we also release pre-built binaries for Windows, Linux and MacOS for i386, x86_64 and arm64. Download them from here.

Run staticreg

Generate a static website staticreg

staticreg generate

Serve the website directly

staticreg serve

Run with Docker

docker run --rm -d cr.seqera.io/public/staticreg:0.1.4 serve --registry <registry-url-here>

Install on Kubernetes

Create a secret with the registry details (the registry you want to list images for)

kubectl create secret generic registry-credentials \
  --from-literal=REGISTRY_USER=<username> \
  --from-literal=REGISTRY_PASSWORD=<password> \
  --from-literal=REGISTRY_HOSTNAME=<hostname>

Create the staticreg deployment

kubectl apply -f manifests/deployment.yml

Contributing

See CONTRIBUTING.md