Skip to content
Allister Banks edited this page Jul 22, 2024 · 3 revisions

Welcome to the SOFA wiki! We hope your usage questions are covered in the README.md, but feel free to open #issues for anything not covered there, or ask in #macadmins-opensource in MacAdmins Slack.

Core Tenets

This space may evolve over time, but for now this splashpage will cover some of the 'tenets' or guidance about how the developers feel about the project: we're all open source volunteers, so please understand there will be a certain amount of 'best effort' support. To be realistic about the features we're most interested in warranty'ing to the best of our ability, this is the ROUGH order in which things will be QA'd and get attention for reliability purposes:

  1. XProtect Remediator/PlugIn versions, to best answer if that specific component is patched on workstations (by parsing Apple's softwareupdate feed)
  2. currently published release history w/date/timestamps, to be the best Nudge backend/server we can be
  3. CVE/KEV for said releases, to afford some type of criticality judgement call
  4. UMA/ipsws for at least the most recent macOS version
  5. The RSS feed, only due to the fact it arrived later in feature development and is less critical than the json representation
  6. Secondarily, everything else in the agreed-upon, set html/GUI - some things may only ever exist in one form and not the other
  7. Tertiarily, everything in the documented schema in json - URLs may move and releases may be dropped from endpoints over time
  8. Peripherarily, everything in the included 'example' scripts should be considered to the best of the people on the git blame's ability to support and maintain, which therefore has the lowest/most informal 'Service Level Objective' - no warranty included or implied
Clone this wiki locally