| title | Quick start |
|---|
Goal: a working Grid control plane on a VM or local machine, pointed at an intent Git repository you own, ready to Sync and Plan.
- Remote Terraform state for anything beyond a disposable lab — Remote state.
- Outbound HTTPS from the host (GitHub, cloud APIs, module bank).
- An intent Git repository you own — Your intent repository and how production reaches it. Do not use the public grid-config sample as production SoT.
export GRID_AUTH_ADMIN_PASSWORD='choose-a-strong-password'
# After creating remote state, also export GRID_TF_* (see remote-state guide)
export GRID_REF=v0.1.0
curl -fsSL https://raw.githubusercontent.com/gridplatform/grid-core/${GRID_REF}/install/install.sh | sudo -E bashOpen http://<host>/, sign in with the bootstrap admin email/password from install/.env.
git clone https://github.com/gridplatform/grid-core.git
cd grid-core
cp install/.env.example install/.env
# Set at minimum:
# GRID_AUTH_ADMIN_PASSWORD
# GRID_TF_BACKEND + the variables for that backend
# GRID_GITOPS_REPO_URL=https://github.com/<you>/<your-desired-state>.git
# GRID_PROMETHEUS_URL / GRID_ALERTMANAGER_URL (host monitoring)
bash install/compose-up.sh
bash install/verify.shFull variable reference: Configuration.
| Step | Where |
|---|---|
| 1. Sign in as bootstrap superadmin | Console login |
| 2. Confirm GitOps / Sources points at your repo | Admin → Sources |
| 3. Sync desired state | Infrastructure sync panel or Sources |
| 4. Pick project + environment in the workspace bar | Shell header |
| 5. Open a unit → Plan (safe) before Apply | Infrastructure / Deployments |
| 6. Create users and assign roles or groups | Admin → Users / Groups |
| 7. Set approval policy on staging/production if needed | Admin → Environments |
- Sync reports tracked units without unexpected errors.
- Plan finishes with live CLI/Terraform logs in the console.
- Remote state objects appear under your backend prefix for applied units.
- Metrics endpoints respond when monitoring is installed (Monitoring).