Skip to main content

GitHub Container Registry (GHCR)

⚡ Active by Default

The ghcr registry module lets you authenticate against the GitHub Container Registry (ghcr.io).

Zero-Config for Public Images

Public packages work out of the box with zero configuration. Configure this module to monitor private repositories or avoid anonymous rate limits.

⚙️ Configuration Variables​

WUD_REGISTRY_GHCR_{registry_name}_TOKEN
Requiredstring

GitHub Personal Access Token (PAT)

Allowed values:Valid GitHub Personal Access Token (`ghp_...` or classic)
WUD_REGISTRY_GHCR_{registry_name}_USERNAME
Requiredstring

GitHub username

WUD_REGISTRY_GHCR_{registry_name}_CONCURRENCY
Optionalintegerdefault: 2

Maximum number of active requests for this GHCR configuration.

Allowed values:Any integer greater than or equal to 1

🚀 Examples​

Authenticate for Private GHCR Packages​

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_REGISTRY_GHCR_LOCAL_USERNAME=johndoe
      - WUD_REGISTRY_GHCR_LOCAL_TOKEN=ghp_1234567890abcdefghijklmnopqrstuvwxyz
      - WUD_REGISTRY_GHCR_LOCAL_CONCURRENCY=2

Limit Anonymous GHCR Requests​

An anonymous registry configuration can set only the concurrency limit:

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_REGISTRY_GHCR_PUBLIC_CONCURRENCY=1

📖 Setup Guide: Creating a GitHub Personal Access Token​

  1. Navigate to GitHub Personal Access Tokens.
  2. Click Generate new token (classic).
  3. Select the read:packages scope (the only scope required by WUD).
  4. Click Generate token, copy the token value, and set it as WUD_REGISTRY_GHCR_{registry_name}_TOKEN.