🐳 ghcr-badge: Generate GitHub Container Registry Status Badges

A lightweight Cloudflare Worker implementation that generates beautiful status badges for your GitHub Container Registry images. Based on eggplants/ghcr-badge.

✨ Features

• 📊 Display container tags in a clean badge
• 🏷️ Show latest tag information
• 📦 Show container image size
• 🎨 Customizable badge colors and labels
• ⚡ Fast and reliable with Cloudflare's global network

🤔 Motivation

The original site for eggplants/ghcr-badge is no longer available often stops working at the end of the month due to the free quota #195 (comment), creating a need for a self-hosted solution. Cloudflare Workers provide an ideal serverless platform for this service, offering reliability and global distribution.

🛠️ Deployment

Prerequisites

• A Cloudflare account
• Node.js and pnpm installed

Steps

1. Clone the repository:

   git clone https://github.com/yuchanns/ghcr-badge-worker
   cd ghcr-badge-worker

2. Install dependencies and deploy:

   pnpm install
   pnpm run deploy  # You'll be prompted to log in to Cloudflare

3. Your badge service will be available at https://your-worker-url.workers.dev

📚 Usage Guide

Available Endpoints

1️⃣ Display Multiple Tags

/:owner/:repo/tags?color=...&ignore=...&n=...&label=...&trim=...

Parameters:

• color: Badge color (default: #44cc11)
• ignore: Tag to ignore (default: latest)
• n: Number of tags to display (default: 3)
• label: Badge label (default: image tags)
• trim: Tag trimming option

Example:

https://ghcr-badge.yuchanns.xyz/containerd/nerdctl/tags?ignore=latest

2️⃣ Display Latest Tag

/:owner/:repo/latest_tag?color=...&ignore=...&label=...&trim=...

Parameters:

• color: Badge color (default: #44cc11)
• ignore: Tag to ignore (default: latest)
• label: Badge label (default: version)
• trim: Tag trimming option

Example:

https://ghcr-badge.yuchanns.xyz/containerd/nerdctl/latest_tag?label=latest

3️⃣ Display Image Size

/:owner/:repo/size?color=...&tag=...&label=...&trim=...

Parameters:

• color: Badge color (default: #44cc11)
• tag: Tag to check size for (default: latest)
• label: Badge label (default: image size)
• trim: Tag trimming option

Example:

https://ghcr-badge.yuchanns.xyz/containerd/nerdctl/size

📝 Add to Your README

![Container Tags](https://your-worker-url.workers.dev/username/repo/tags)
![Latest Version](https://your-worker-url.workers.dev/username/repo/latest_tag)
![Image Size](https://your-worker-url.workers.dev/username/repo/size)

📄 License

This project is licensed under the Apache License - see the LICENSE file for details.

---

Made with ❤️ by yuchanns