PSA/ee/docs/appliance/quick-start.md
Hermes 284313f908
Some checks are pending
Bidi Control Character Guard / bidi-control-guard (push) Waiting to run
Circular Dependency Check / Check for new circular dependencies (push) Waiting to run
Citus Migration Smoke / Combined migrations on single-node Citus (push) Waiting to run
E2E Fresh Install Tests / fresh-install-e2e (push) Waiting to run
ext-v2 guardrails / Run ext-v2 guard and ESLint (push) Waiting to run
Integration Tests / Check for relevant changes (push) Waiting to run
Integration Tests / ${{ (github.event_name == 'schedule' || github.event.inputs.suite == 'full') && 'Full integration suite' || 'Tier-1 integration subset' }} (push) Blocked by required conditions
Mobile checks / Mobile lint + typecheck (push) Waiting to run
Mobile checks / Mobile unit tests (push) Waiting to run
Mobile checks / Mobile dependency audit (report) (push) Waiting to run
Mobile checks / Mobile reproducibility checks (push) Waiting to run
Secrets guard (env backups) / Ensure no tracked env backup files (push) Waiting to run
Temporal Readiness / fast-readiness (push) Waiting to run
Temporal Readiness / docker-parity (push) Waiting to run
TypeScript Type Check / Nx affected typecheck (push) Waiting to run
Unit Tests / Skipped-test budget (push) Waiting to run
Unit Tests / Nx affected unit tests (push) Waiting to run
Unit Tests / Server unit coverage (informational) (push) Waiting to run
Validate Tenant Management Schema / Check for relevant changes (push) Waiting to run
Validate Tenant Management Schema / Validate Tenant Management Schema (push) Blocked by required conditions
EE Workflows Build Guard / ee-workflows-build-guard (push) Waiting to run
Initial import of AlgaPSA codebase from PSA server
Excluded: .git, node_modules, secrets/, compose.env, assemblyscript tgz

Source: /opt/alga-psa on psa.joliet.tech
2026-06-22 16:12:17 -05:00

56 lines
1.7 KiB
Markdown

# Quick Start Guide (Ubuntu Appliance)
This guide covers new installs on VMware ESXi or cloud VMs using the Ubuntu appliance ISO.
## 1. Prepare VM
- Create a VM with a new disk and attach the Alga Ubuntu appliance ISO.
- Use networking that allows a workstation browser to reach VM port `8080`.
- Prefer DHCP reservation or static IP so the setup URL stays stable.
## 2. Boot ISO And Wait For First Reboot
- Ubuntu autoinstall runs unattended.
- VM reboots into installed Ubuntu Server 24.04 LTS.
## 3. Open Setup
After reboot, console shows:
- node IP
- setup URL: `http://<node-ip>:8080/setup`
- setup token
- console fallback command
Open setup URL from your workstation and include the setup token.
## 4. Complete Setup
Required values:
- release channel (`stable` default, `nightly` for testing/support-directed use)
- app URL/hostname
- DNS mode (`DHCP/system resolvers` default)
- optional support/testing repo URL/branch override
Important DNS behavior:
- default keeps system/DHCP resolvers
- custom public DNS (for example `8.8.8.8,8.8.4.4`) is deliberate opt-in
- do not override internal AD/split-horizon DNS unless intended
Setup runs preflight checks for DNS, GitHub channel access, GHCR reachability, and proxy/egress before k3s install.
## 5. Track Status
Use `http://<node-ip>:8080` for status and diagnostics during and after setup.
Readiness tiers include platform/core/bootstrap/login/background/fully-healthy.
Background service issues do not block login readiness.
## 6. App Updates
Use `http://<node-ip>:8080/updates?token=<status-token>` for app-channel updates (`stable` or `nightly`).
v1 scope is app-only updates. Ubuntu and k3s updates are manual/support-run.