Documentation
Ship clean install URLs for your GitHub projects
easy-install.sh gives your GitHub packages vanity URLs with built-in anonymous analytics. Docker images, shell scripts, and raw file content, all forwarded through a single, clean namespace.
Quick Start
Pull container images through a vanity registry URL
docker pull easy-install.sh/you/appPipe install scripts through a memorable URL
curl -sSL easy-install.sh/you/app/install.sh | shClone repos through a vanity URL
git clone easy-install.sh/you/appServe any raw file from your repo
curl -sSL easy-install.sh/you/app/config.yamlNamespace Resolution
How URLs map to upstream sources
Command
docker pull easy-install.sh/acme/api:v2
GitHub username or org
→ ghcr.io/acme
Repository name
→ ghcr.io/acme/api
Image tag or digest
→ :v2
Resolves to
ghcr.io/acme/api:v2
Command
docker pull easy-install.sh/acme/api:v2
GitHub username or org
→ ghcr.io/acme
Repository name
→ ghcr.io/acme/api
Image tag or digest
→ :v2
Resolves to
ghcr.io/acme/api:v2
Command
docker pull easy-install.sh/acme/api:v2
GitHub username or org
→ ghcr.io/acme
Repository name
→ ghcr.io/acme/api
Image tag or digest
→ :v2
Resolves to
ghcr.io/acme/api:v2
Command
docker pull easy-install.sh/acme/api:v2
GitHub username or org
→ ghcr.io/acme
Repository name
→ ghcr.io/acme/api
Image tag or digest
→ :v2
Resolves to
ghcr.io/acme/api:v2
Reference
URL Patterns
| Pattern | Mode | Resolves To |
|---|---|---|
| easy-install.sh/{ns}/{project} | Docker | ghcr.io/{ns}/{project}:latest |
| easy-install.sh/{ns}/{project}:{tag} | Docker | ghcr.io/{ns}/{project}:{tag} |
| easy-install.sh/{ns}/{project} | Git Clone | github.com/{ns}/{project}.git (via 307 redirect) |
| easy-install.sh/{ns}/{project}.git | Git Clone | github.com/{ns}/{project}.git (via 307 redirect) |
| easy-install.sh/{ns}/{project}/{path} | Script / Content | raw.githubusercontent.com/{ns}/{project}/HEAD/{path} |