Getting Started

Prerequisites

• Docker 20.10+ or Docker Compose 2.0+
• A running Docker Registry (v2)
• Port 5000 available (or configure different port)

Installation Methods

1. Docker Run

Quick start with a single command:

docker run -d \
  --name registry-ui \
  -p 5000:5000 \
  -e CONFIG_FILE=/app/data/registries.config.json \
  -e READ_ONLY=false \
  -v $(pwd)/data:/app/data \
  ghcr.io/vibhuvioio/docker-registry-ui:latest

2. Docker Compose

Create a docker-compose.yml file:

version: '3.8'

services:
  registry:
    image: registry:2
    ports:
      - "5001:5000"
    environment:
      REGISTRY_STORAGE_DELETE_ENABLED: "true"
    volumes:
      - registry-data:/var/lib/registry

  registry-ui:
    image: ghcr.io/vibhuvioio/docker-registry-ui:latest
    ports:
      - "5000:5000"
    environment:
      - CONFIG_FILE=/app/data/registries.config.json
      - READ_ONLY=false
    volumes:
      - ./data:/app/data
    depends_on:
      - registry

volumes:
  registry-data:

Start the services:

docker-compose up -d

3. Development Setup

For local development:

# Clone the repository
git clone https://github.com/vibhuvi/docker-registry-ui.git
cd docker-registry-ui

# Create virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Run the application
python app.py

First Run Setup

No configuration file needed! The UI includes a setup wizard for easy first-time configuration.

1. Access the UI at http://localhost:5000
2. The setup wizard appears automatically on first run
3. Enter your Docker Registry details:
   • Registry Name: Friendly name (e.g., "Local Registry")
   • Registry URL: API endpoint (e.g., http://localhost:5001)
   • Authentication: Enable if your registry requires credentials
4. Click "Test Connection" to verify connectivity
5. Save configuration - it's automatically persisted to /app/data/registries.config.json
6. Start managing your registry!

Note: For automated deployments, you can pre-create the config file. See Configuration Guide.

Environment Variables

Next Steps

• Configure Multiple Registries
• Set Up Vulnerability Scanning
• Explore All Features