Install scaffold
Choose the right scaffold integration and follow the installation route that is currently available.
Scaffold runs inside the learning platform your institution already uses. The integration is installed once by an administrator; authors then create Scaffold activities without running a separate service.
Current release status
Scaffold 0.1.2 is the latest coordinated alpha release:
- The Open edX XBlock is published on PyPI.
- The official Moodle package is
mod_scaffold-0.1.2.zip. - Both packages belong to the Scaffold 0.1.2 GitHub prerelease.
The Moodle plugin has been submitted to Moodle Marketplace and is awaiting review. Until the listing is approved, use the exact versioned ZIP attached to the GitHub release. Do not use GitHub’s automatically generated Source code archives as installable Moodle packages.
Scaffold is alpha software. Evaluate it in a non-production environment before using it with live learners.
Want to see the editor before installing it? Try the playground. It runs in your browser and does not require Moodle or Open edX.
Release 0.1.2 is free and requires no subscription, paid feature, external Scaffold account, API key, or separate Scaffold service. The packaged Moodle plugin is GPL-3.0-or-later; the wider Scaffold repository is AGPL-3.0-only.
Choose your platform
Moodle
Scaffold installs as the native mod_scaffold activity module. Start
with Installing into Moodle for the 0.1.2 ZIP,
requirements, data ownership, and verification steps.
Open edX
Scaffold installs as the scaffold XBlock in both the LMS and
CMS/Studio environments. Start with Installing into Open
edX for the persistent, pinned PyPI installation
and enablement steps.
LTI 1.3 platforms
Canvas, D2L Brightspace, Blackboard, and other LTI 1.3 platforms are not supported yet. See LTI 1.3 status for the current scope.
Where installation instructions are maintained
This page is the public starting point. Each platform page gives the administrator workflow, while the administrator guide packaged with the integration remains the technical source of truth for that exact release.
Release availability is determined by the published channel:
- Moodle: the exact versioned GitHub Release ZIP while the submitted Moodle Marketplace listing awaits review. Once approved, Marketplace becomes the primary route and GitHub remains the verified fallback.
- Open edX: the pinned package on PyPI, with the exact versioned GitHub Release wheel as the verified fallback.
Every installation should use an exact released version and verify the installed version after the LMS has restarted or completed its upgrade.
Learning records
Both current integrations can accept Scaffold’s optional xAPI learning records into the LMS’s own event pipeline. These provide richer visibility into the learner journey—for example, moving through content, opening hints, interacting with blocks, submitting answers, and progressing through quizzes. This is separate from learner state and official grading, and requires no Scaffold account or hosted Scaffold service. Read Learning records and xAPI before deciding how your institution will retain or consume those events.
For questions, feedback, and release discussion, join the Scaffold conversation in the Moodle community forum.