Skip to main content

Install overview

Install scripts and Compose live in grid-core/install. These pages explain which path to use and what you must configure.

Choose a path​

PathWhat runsGuide
Remote state firstObject store for Terraform state + archive mirrorRemote Terraform state
Cloud credentialsHow the host authenticates to providersCloud accounts and credentials
Compose on a VM (default)Docker: core + uiDocker Compose · VM · install.sh
Native VMNode + systemd + host nginxVM with GRID_USE_NATIVE=1
Release imagesGHCR current / lts / pinned versionReleases
Dev from sourcenpm run devDev vs prod

Order of operations

  1. Create remote state (guide)
  2. Install Grid (Compose or native)
  3. Point Sources at your desired-state repo
  4. Install host monitoring (guide)
  5. Sync → Plan → Apply

Skipping remote state is acceptable only for a disposable local lab.

What gets installed​

  1. grid-core — API, auth, GitOps sync, release runner
  2. grid-ui — console (static build behind nginx)
  3. grid-cli — bundled / cloned for Core to spawn
  4. Terraform ≥ 1.5 (image pins a concrete version)
  5. Desired-state working tree — clone of your Git remote into GRID_CONFIG_ROOT
  6. Module bank — grid-terraform at a pinned ref

grid-config is an example repository only.

Version pinning​

Set GRID_REF to the tag you want (Releases, Downloads):

export GRID_REF=v0.1.0
curl -fsSL https://raw.githubusercontent.com/gridplatform/grid-core/${GRID_REF}/install/install.sh | sudo -E bash

Next​