Quickstart

This walks through booting an end-to-end OrbitalReg locally. You'll end with a registry that accepts uploads, mirrors a real Maven artifact from upstream, and shows you the scan findings.

Prerequisites

• Docker (Compose v1 or v2) — if docker compose version works, you're set
• Go 1.22+ (only required if you want to rebuild the API; pre-built images are available)
• Node 18+ (only required if you want to rebuild the SPA)

Bring everything up

The repository ships a one-liner that starts Postgres + Redis + MinIO, applies migrations, and starts the API and the Vite dev server in parallel:

git clone https://github.com/orbitalreg/orbital-enterprice
cd orbital-enterprice
make dev

After ~30 seconds:

• API: http://localhost:8080
• Frontend: http://localhost:5173

The default admin credentials are seeded into the dev container — read them from make local-status or the migration log.

Verify the install

Open http://localhost:5173/admin/version. You should see a version badge of the form vX.Y.Z-<sha> matching the local git checkout.

curl http://localhost:8080/api/public-config | jq .

The endpoint returns a small JSON envelope of version, help_url, logo_url, and the active customer banner (if any). Both the Login page and the main AppShell read it.

Upload an artifact

Pick any local Maven jar:

mvn deploy:deploy-file \
  -Dfile=./target/sample-1.0.0.jar \
  -DgroupId=com.example \
  -DartifactId=sample \
  -Dversion=1.0.0 \
  -Dpackaging=jar \
  -DrepositoryId=orbital-local \
  -Durl=http://localhost:8080/maven/<project-slug>/<repo-slug>

Within a few seconds the artifact appears under Projects → <project-slug> → <repo-slug>, with a Detection banner if the bundled scanners flag anything.

Tear it down

make local-down

make local-reset wipes the volumes and reapplies migrations from a clean state.

Next steps

• Getting started with the API — the same flow end-to-end via REST (sign in, mint a token, push, pull, promote), with a .gitlab-ci.yml snippet at the end
• Installation — deploy to a real cluster
• Architecture — what's actually inside the binary
• Core concepts — projects, repos, scans, blocks