distroface

A container registry built for developers. Convenient and without compromise.

DistroFace Docs

Features

• Built-in Authentication & Authorization
• Modern Web UI
• Image Migration Tool
• Role-Based Access Control
• Tag Management
• Registry Statistics

API Endpoints

Authentication

Registry Operations

Group & Role Management

Artifact Management

Settings Management

User Management

Migration

DFCli - API Client Tool

dfcli is a command-line interface for interacting with DistroFace. It provides commands for managing images, artifacts, users, groups, roles, and settings.

Get the cli

The dfcli binary can be obtained from the releases tab (if one exist) or can be built by cloning this repo and running make build-cli in the project root.

Authentication

# Login to server
dfcli login
dfcli login -u username -p password

# Logout
dfcli logout

Image Management

# List images
dfcli image list

# Manage image tags
dfcli image tags <image-name>
dfcli image delete <image-name> <tag>

# Update visibility
dfcli image visibility <image-name> <public|private>

Artifact Management

# Create/list repositories
dfcli artifact create <repo> [-d description] [-p]
dfcli artifact list

# Upload artifacts
dfcli artifact upload <repo> <file> [-v version] [-p path] [--property key=value]

# Download artifacts (using query route)
# - By default, if exactly one artifact matches, returns that file
# - If multiple match, returns ZIP or TAR.GZ (or force archive with --archive)
dfcli artifact download <repo> \
  --version 1.2.3 \
  --path bin/cli-binary \
  --property env=production \
  --archive \
  --format tar.gz \
  --output downloaded.tar.gz

# Or with shorter flags:
dfcli artifact download my-repo -v 1.2.3 -p bin/cli-binary -P env=prod,branch=main --archive --format zip -o out.zip

# Delete artifacts (legacy direct path)
dfcli artifact delete <repo> <version> <path>

# Search artifacts
dfcli artifact search [--property key=value]

User Management

# List and manage users
dfcli user list
dfcli user create <username> -p <password> [-g group1,group2]
dfcli user delete <username>
dfcli user groups <username> -g <group1,group2>

Group Management

# List and manage groups
dfcli group list
dfcli group create <name> -d <description> -r <role1,role2>
dfcli group update <name> [-d description] [-r role1,role2]
dfcli group delete <name>

Role Management

# List and manage roles
dfcli role list
dfcli role update <name> [--add ACTION:RESOURCE] [--remove ACTION:RESOURCE]
dfcli role delete <name>

Settings Management

# View and manage settings
dfcli settings get <section>
dfcli settings update <section> -s key=value
dfcli settings reset <section>

Configuration

The CLI configuration is stored in ~/.dfcli/config.json. You can specify a different server URL using the --server flag or by setting it in the config file:

dfcli --server http://registry.example.com

[!note] registry.example.com would also work, assuming http not https.

Authentication Model

Distroface runs the webui user auth and permissions model through the same channels as the docker client.

Quick Start

# Run with Docker
docker run -p 8668:8668 \
  -v /path/to/data:/data \
  nickheyer/distroface:latest

# Default login
Username: admin
Password: admin

Development

# Install dependencies
make deps

# Build + run in development mode
make dev

# Build for production
make build

# Build the cli tool
make build-cli

License

MIT License - see LICENSE for details