Getting Started

Stout is a universal package registry that builds everything from source. This guide walks you through setting up a local instance with Docker Compose.

Prerequisites

  • Docker and Docker Compose installed
  • Git installed

Quick Start

Clone the repository and start the server:

git clone https://github.com/jdziat/registry-server.git
cd registry-server
docker compose up -d

Verify the server is running:

curl http://localhost:7888/healthz
# {"status":"ok"}

Default Ports

Service Port
Registry API 7888
PostgreSQL 5432
MinIO (S3) 9000

Environment Variables

Key configuration options (set in .env or passed to Docker Compose):

Variable Default Description
DATABASE_URL — PostgreSQL connection string
S3_BUCKET artifacts S3-compatible bucket for artifact storage
LISTEN_ADDR :7888 Address and port the server binds to
SIGSTORE_ENABLED true Enable Sigstore keyless signing

Next Steps

Once the server is running, configure your package manager to use it: