-
Notifications
You must be signed in to change notification settings - Fork 0
FAQ
For deeper operational guidance see
docs/troubleshooting.md.
What is SPARC? A Rails 8.1 application for managing NIST SP 800-53 compliance documentation — SSPs, SARs, SAPs, POA&Ms, CDEFs, and control catalogs — with a REST API and OSCAL v1.1.2 import/export. SPARC is a translation engine + UI for OSCAL / policy-as-code, not a system of record: tenant systems own the source of truth.
Which OSCAL version does SPARC target? NIST OSCAL v1.1.2. The schemas are baked into the container so validation works air-gapped (no dependency on NIST GitHub availability at runtime).
Spreadsheet (Excel) upload doesn't appear in the UI — why? Excel import/export code is preserved for API consumers but is no longer surfaced in the UI by default. The parser services remain for programmatic use.
I can't log in — there's no login form.
All auth modes default to disabled. Enable at least one, e.g.
SPARC_ENABLE_LOCAL_LOGIN=true, then bootstrap an admin with
bin/rails sparc:bootstrap_admin. See Configuration.
The OIDC/Okta or LDAP tab does nothing when clicked. This was a CSP regression fixed in v1.8.1. Ensure you're on ≥ v1.8.1.
SSO buttons do nothing in Chrome/Edge but work in Firefox.
Fixed in v1.8.5 — Chromium enforces CSP form-action on every redirect hop.
Upgrade to ≥ v1.8.5.
Deploy fails on a "Email has already been taken" / case-variant email.
v1.8.5 added a DB-enforced LOWER(email) unique index. Resolve pre-existing
case-variant duplicate emails before deploying.
A deploy "hangs" or the container restarts during a long migration. Long data migrations now use the deferred pattern (v1.8.3): the container binds its port immediately and the migration body runs post-boot via Solid Queue. Check Admin → Data Migrations for status.
I edited db/seeds/*.rb but production didn't pick up the change.
Bump the section version in SeedRunner::CURRENT_VERSIONS — SeedRunner.run_section
skips a section whose version already matches (the v1.6.6 converters incident).
A new AWS converter / CDEF didn't appear after deploy.
Same cause as above — confirm the relevant SeedRunner version was bumped, and
for AWS Labs CDEFs that SPARC_AWS_LABS_CDEF_ENABLED=true.
My OSCAL export was rejected. Exports are validated against the NIST v1.1.2 schemas before download. CDEF mutations are validated pre-commit (v1.8.0) — an invalid result is rejected rather than persisted. Check the error detail for the failing JSON pointer.
Getting Started
User Guides
- User Guides (index)
- Getting Oriented
- Authorization Boundaries
- Control Catalogs & Baselines
- Converters & Imports
- System Security Plans (SSP)
- Component Definitions (CDEF)
- Security Assessment Plan (SAP)
- Security Assessment Results (SAR)
- POA&M
- Evidence & Attestations
- HDF Amendment Triage
- Compliance Library
- Security Keys & Smart Cards
- Administration
Documentation
- RBAC (Role-Based Access Control)
- Data Isolation
- Screens & UI
- Core Functions & Features
- Framework Mapping
- Integrations
- Architecture
- API Reference
Reference
Links