Skip to content

README.md

Latest commit

 

History

History
63 lines (41 loc) · 2 KB

README.md

File metadata and controls

63 lines (41 loc) · 2 KB

Sorcerer

A minimal OCI (Open Container Initiative) registry server implemented in Go.

Overview

Sorcerer is a lightweight container registry that complies with the OCI distribution specification. It provides a simple way to store and distribute container images privately.

Features

  • OCI-compliant container registry
  • Simple configuration
  • Minimal dependencies
  • Lightweight design
  • HTPASSWD authentication support

Usage

Docker

The official docker image is available on GitHub Container Registry (ghcr.io).

# Pull the latest image
docker pull ghcr.io/dvjn/sorcerer:latest

# Run docker image
docker run -p 3000:3000 -v "$(pwd)/data:/app/data" ghcr.io/dvjn/sorcerer:latest

CLI

You can build and install sorcerer from source using goblin:

# Build and install from main
curl -sf http://goblin.run/github.com/dvjn/sorcerer | CMD_PATH="/cmd/sorcerer" sh

# Run the server
sorcerer

Configuration

Sorcerer can be configured using the following environment variables:

Environment Variable Default Description
PORT 3000 Port to run the server on.
STORE__PATH data Path to store registry data.
AUTH__MODE none Authentication mode. Can be none or htpasswd.
AUTH__HTPASSWD__FILE - Path to htpasswd file (required when AUTH__MODE=htpasswd).
AUTH__HTPASSWD__CONTENTS - Inline htpasswd contents (alternative to file). One per line in user:hash format.
LOG__LEVEL info Log level. Can be set to debug, info, warn, error, fatal, or panic.

License

This project is licensed under the MIT License.