🗂️ Create a custom registry

An ASC registry is static JSON: registry.json links to category indexes, and each category lists packages.

my-registry/
├── registry.json
└── categories/web.json

// registry.json
{
  "name": "acme-registry",
  "format_version": 1,
  "categories": [{ "name": "web", "index": "categories/web.json" }]
}

// categories/web.json
{
  "category": "web",
  "packages": [{
    "name": "example-web",
    "type": "app",
    "description": "Example web application",
    "source": { "git": "https://github.com/acme/example-web" }
  }]
}

GitHub repository

Commit the files to a public repository, then add its raw directory URL:

asc source add https://raw.githubusercontent.com/acme/my-registry/main --name acme
asc update
asc search example-web
asc install example-web --source acme

Your own site

Serve the JSON directory over HTTPS. For Nginx:

server {
  listen 443 ssl;
  server_name packages.example.com;
  root /var/www/asc-registry;
  location / { try_files $uri =404; }
}

sudo asc source add https://packages.example.com --name acme
asc update
asc search example-web

Use the registry schemas to validate JSON. sudo asc source add makes the source available to all server users; without sudo it is per-user.