seqeralabs / staticreg

A tool to generate a static website from an OCI registry containing all the images and tags the provided user has access to.
Apache License 2.0
0 stars 0 forks source link

:package: staticreg

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

Features

:white_check_mark: Images list page
:white_check_mark: Image tags list page
:white_check_mark: Static website

staticreg screenshot

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

Serve the website

staticreg serve

Run with Docker

docker run --rm -d cr.seqera.io/public/staticreg:0.2.0 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