Skip to content

configuration.md

Latest commit

 

History

History
74 lines (54 loc) · 3.01 KB

configuration.md

File metadata and controls

74 lines (54 loc) · 3.01 KB
Raw
title Configuration

Configuration

Environment variables for grid-core. Prefer the install-oriented template:

grid-core/install/.env.example

Developer template (same variables, more comments):

grid-core/.env.example

The CLI inherits paths when Core spawns it.

Required / commonly set

Variable Purpose Typical install value
PORT API listen port 3000
GRID_DATA_DIR JSON store (users, releases, audit) ./data or /var/lib/grid/data
GRID_WORK_DIR Terraform workspaces ./workspaces or /var/lib/grid/workspaces
GRID_CLI_ROOT Path to grid-cli package /opt/grid/grid-cli
GRID_CONFIG_ROOT Desired-state working tree /opt/grid/grid-config or ./data/desired-state
GRID_MODULE_BANK Module bank git URL or path https://github.com/gridplatform/grid-terraform.git
GRID_MODULE_BANK_REF Branch/tag for module bank main or a release tag
GRID_TERRAFORM_BIN Terraform binary terraform

Auth

Variable Purpose
GRID_AUTH_ADMIN_EMAIL Bootstrap admin
GRID_AUTH_ADMIN_PASSWORD Must change before any shared host
GRID_AUTH_SESSION_TTL_HOURS Session length (default often 168)
GRID_AUTH_ALLOW_REGISTER Public self-register (keep false for self-host)
GRID_AUTH_DISABLED Dev only — never on a public VM

GitOps (desired-state sync)

Variable Purpose
GRID_GITOPS_REPO_URL Remote desired-state repo (e.g. your fork of grid-config)
GRID_GITOPS_BRANCH Branch to pull
GRID_GITOPS_PATH Optional subdirectory
GRID_GITOPS_SYNC_INTERVAL_SEC Auto-pull interval; 0 = manual

If GRID_GITOPS_REPO_URL is set, Core clones/pulls into GRID_CONFIG_ROOT.

Remote Terraform state (recommended for every VM)

Create the store before the first apply — Remote state guide.

Variable Backend Purpose
GRID_TF_BACKEND — s3 | gcs | azurerm | local (default, lab only)
GRID_TF_STATE_BUCKET s3, gcs Bucket name
GRID_TF_LOCK_TABLE s3 DynamoDB lock table
GRID_TF_STATE_REGION s3 Region
GRID_TF_AZURE_RESOURCE_GROUP azurerm Resource group
GRID_TF_AZURE_STORAGE_ACCOUNT azurerm Storage account
GRID_TF_AZURE_CONTAINER azurerm Blob container

Keys are per desired-state unit so dependsOn can read VPC/other outputs from remote state.

UI

Point the console at the API (Vite / build-time env — see grid-ui README), e.g. VITE_API_URL=https://grid.example.com/api or http://<vm-ip>:3000.

Secrets hygiene

  • Never commit .env.
  • Prefer instance roles / OIDC over long-lived keys on the VM when possible.
  • Rotate GRID_AUTH_ADMIN_PASSWORD after first login if the image was shared.