Settings
This guide covers the General, Build, and Environment tabs in site settings: name, branch, auto-deploy, release-based deployment, build configuration, build stages, and environment variables.
Opening Site Settings
- From the site overview, open the site
- Go to Settings (e.g. from the sidebar or site menu)
- Use the settings tabs to switch between General, Build, Releases, Domains, Environment, Resources, and Danger
General Settings
Path: Settings → General
Site Name
Display name for the site. Used in the UI and in links. You can change it at any time.
Production Branch
The Git branch to deploy from (e.g. main, master, develop). Manual deploys and (when enabled) auto-deploys use this branch.
Auto-deploy on push
- When enabled, pushing to the production branch (e.g. via GitHub webhook) triggers a new deployment automatically
- When disabled, you deploy only by clicking Deploy on the site page or by creating a release (if release-based is enabled)
Release-Based Deployments
When Release-Based Deployments is enabled:
- Deployments are triggered by GitHub releases instead of (or in addition to) branch pushes
- Trigger on Release Action:
- Published - Deploy when a release is published (no longer draft)
- Released - Deploy when the release is publicly available (recommended for production)
- Include Pre-releases - When enabled, pre-releases (alpha, beta, RC) also trigger deployments
Save the form to apply general settings.
Build Settings
Path: Settings → Build
Output Directory
The folder where the build writes static files (e.g. dist, build, out, .output/public). Must match your project's build output. Orkestia uploads this folder to S3 and serves it via CloudFront.
Node.js Version
Node.js version used in the build (e.g. Node 18 LTS, Node 20). Choose the version your project requires.
Build Pipeline (Build Stages)
Build stages run in order during each deployment (e.g. install dependencies, then build) on a managed build runner in your own cloud.
Each stage has:
| Field | Description |
|---|---|
| Name | Label (e.g. Install, Build) |
| Command | Shell command (e.g. npm install, npm run build) |
| Timeout | Max time in seconds (optional) |
| Continue on error | When enabled, the pipeline continues even if this stage fails |
- Add Stage - Add a new stage
- Remove - Remove a stage
- Order can usually be changed (move up/down)
Environment Variables
Path: Settings → Environment
Environment variables are available at build time (e.g. for npm run build). They are stored encrypted and are not shown after saving (values are write-only for security).
Adding a Variable
- Enter Key (e.g.
API_URL,NODE_ENV) and Value - Click Add
- The variable is saved and appears in the list by key (value is not displayed)
Deleting a Variable
Click the delete (trash) action next to the variable. Confirm if prompted. The variable is removed for future builds.
Applying Changes
Changes to env vars apply to the next deployment. Trigger a new deployment from the site page (or push/release) to use the new or updated values.