User & Admin Documentation

Everything you need to deploy, configure, and operate the Forail platform.

For backend architecture, API reference, database schema, and contributor guides, see the Developer Docs.

Getting Started

Document	Description
Architecture Overview	System diagrams, component roles, request flows, port reference
Docker Deployment	Deploy with Docker Compose, TLS, backups, scaling, troubleshooting
Kubernetes Deployment	Helm chart on k3s/kubeadm with HA control plane, ingress, PVCs
Operator v1.0.0	9 CRDs, multi-cluster control plane, declarative Workflow DAG, OLM bundle
AWX → Forail Migration	One-shot idempotent import of orgs, inventories, credentials, templates, workflows, schedules and RBAC from AWX/AAP

Features

Feature	Description
Event-Driven Automation	HMAC-verified webhooks with Jinja2 conditions
Drift Detection	Configuration drift detection with alert rules and compliance export
Policy-as-Code (OPA)	Rego rules for launch-time policy enforcement
Self-Service Portal	Automation catalog with approval workflows
Multi-Tenancy	Per-org quotas, branding, isolation
OIDC + WebAuthn	SSO, FIDO2 passkeys, MFA enforcement
IaC Scanning	ansible-lint, checkov, pip-audit pre-launch scanning
Observability	OpenTelemetry traces and metrics
Dynamic Surveys	Runtime choice resolution from DB, API, or Jinja2
Audit Trail	Immutable security audit log with CSV/SIEM export
Recommendations	Rule-based actionable improvement suggestions

AI Assistant

Document	Description
Architecture	RAG pipeline, Ollama, ChromaDB, all-in-one container
API Reference	Chat, health, and indexing endpoints
Configuration	Environment variables, model selection, document sources
Deployment	Standalone and integrated deployment, GPU support

Operations

Document	Description
User Handbook	Step-by-step guide for every UI page with screenshots
Admin Handbook	Installation, day-2 operations, scaling, security, troubleshooting

Release Notes

Version	Highlights
v2026.07.0	Security-hardening & migration — one-shot AWX → Forail importer, SAML signed-assertion/SHA-256 defaults (breaking), session-key hashing, trusted-proxy audit IP, RBAC role-assignment fix
v2026.06.0	Project renamed forge → forail (org forail-platform), ghcr.io image namespace, CRD group forail.forail-platform.io, CalVer unified
v2026.05.0	Platform GA — operator v1.0.0 (multi-cluster, 9 CRDs), 3m+4w k3s, all-in-one assistant
v2026.04.0	EDA, AI Assistant, Dynamic Surveys, Audit Trail, 6 new features
v2026.03.0	Initial release — modernized AWX with React UI