How to enable Insturqt in Open edX?
Overview
Instruqt is a virtual IT lab platform that lets authors build hands-on tutorials, software demos, and interactive coding sandboxes without requiring learners to download or install local packages. When integrated into a course run via its native XBlock, student environment completion statuses are synchronized dynamically with the platform database.
Tip: Ensure you are logged into Open edX Studio with appropriate Admin or Staff permissions before proceeding.
Pre-requisite: You must possess administrator rights on your organization's Instruqt dashboard to retrieve secure track embed sources.
Step 1: Register the Instruqt XBlock in Advanced Settings
Before you can drop lab environments into individual course pages, you must register the specific processing module key within your course configuration arrays.
Procedures:
- Open your course run in Studio.
- From the Settings menu in the top navigation bar, select Advanced Settings.
- Scroll down or search the browser window to locate the Advanced Module List field.
- Inside the square brackets
[ ], add the plugin string key precisely as:"instruqtxblock"- Note: If other advanced tool strings are already configured, separate each entry with a comma (e.g.,
["library_content", "instruqtxblock"]). Ensure you use standard straight double quotes.
- Note: If other advanced tool strings are already configured, separate each entry with a comma (e.g.,
- Click Save Changes at the bottom of the page.
Step 2: Embed the Component into a Unit Layout
Once saved, the system loads the lab builder tools directly into your unit component selection options.
Procedures:
- Go back to your Course Outline page under the Content menu.
- Enter the specific Unit page where you want to embed the lab exercise.
- Scroll to the Add New Component toolkit selection area at the bottom of the page canvas.
- Click the Advanced tile.
- Select Instruqt from the expanded options list. The block container will load immediately onto your unit canvas.
Step 3: Configure Your Lab Block Connection Parameters
The final step maps the embedded container block directly to your specific hosted sandbox tutorial.
Procedures:
- Find your newly added Instruqt component block on the unit canvas and click Edit.
- Fill out the following parameters within the modal configuration view:
- Display Name: Enter a customer-facing title (e.g., Hands-On Sandbox: Linux CLI Basics).
- Track Embed Code: Log into your external Instruqt dashboard and navigate to your Track Detail Page. Click the option for Embedding and copy only the secure source URL string from inside the iframe code block (do not copy the surrounding HTML tags). Paste that absolute source URL path into this text field.
- Height and Width: Specify the rendering container box scale metrics in pixels or percentages (e.g.,
100%width and700pxheight) to control how the interface opens on the learner's device view. - Calculate score on challenge completion: If this exercise is graded or maps to your course syllabus milestones, toggle this field choice to True. The system will calculate scores based on the proportion of passed exercises:
SCORE = [Number of Completed Challenges]/[Total Challenges in Track]
- Click Save.
- Click the Publish button in your right-hand unit status sidebar to push the changes live to the LMS.
Learner Perspective inside the LMS
When an enrolled student encounters this unit page within the Learning Management System (LMS) player, the embedded virtual terminal loads natively inside the viewport. Learners can interact with the live command line, complete step-by-step challenges, and verify code sequences from their browser. Once the track is fully cleared, completion records report back to the server and update their personal Progress dashboard analytics automatically.