Instruqt Docs

Instruqt Docs

• Overview: An overview of Instruqt's lab platform, and its usage.
• Setting up: How to sign up and install the CLI.
• Study Room
• Quickstart: Learn how to deploy your first Instruqt track.
• Manage tracks
• Create tracks: Learn how to create tracks.
• Edit locally: Edit tracks on your local machine and push changes to Instruqt
• Test tracks: Test track sandboxes by running simulated plays
• Track logs: Inspect track logs and troubleshoot your configurations
• Track time limits: Learn how to configure track time limits and idle timeouts
• Pausable tracks: Enable learners to pause tracks and resume later, preserving their progress and environment state while optimizing resource usage.
• Track feedback: Decide when users are able to share feedback about the track.
• Developer workflow: Keep your track building under control using CI/CD pipelines
• Track tags: How to manage tags and add them to your content in order to group related items together.
• Track authors: Add and remove authors to tracks
• Delete tracks: Delete tracks to cleanup your team
• Custom layouts: Learn how to enable, and customise your lab layouts and themes. Custom layouts help you create a tailored lab experience for your product.
• Version control: Learn how to use version control in your tracks. Version control helps you streamline development processes, enable faster iteration and delivery of tracks.
• Loading experience: Learn how to configure the loading experience for tracks and challenges
• Challenges
• Create challenges: Challenges are the steps in a track a user must complete.
• Challenge tabs: Configure different tab types in challenges.
• Challenge order: Modify the order of your track's challenges
• Skip challenges: Enable users to skip challenges in your tracks
• Add quizzes: Check your learners knowledge with a multiple choice question
• Assignment display: Learn how to customise the presentation of your challenge for your users
• Assignment editor: Modify the instructions presented to the learner
• Share tracks
• Live Events: Run live events with the Instruqt Live Event dashboard
• Instructor tools: This page covers the tools available to instructors to help them facilitate their virtual and in-person events. These tools include messaging, raised hands, and user management through the dashboard.
• Track invites: Grant learners controlled access to your tracks
• Form Settings
• Embed tracks: Integrate Instruqt into your web pages or platform.
• Landing pages: Create a custom page to share your tracks
• Overview: An overview of Instruqt sandboxes.
• Sandbox hosts
• Add hosts: How to add virtual machines and containers to sandboxes.
• Custom VM images: Create custom VM images for use in your sandboxes.
• Custom container images: Create custom container images for your sandboxes.
• Public images: Build off of publicly accessible images.
• Windows VMs: Run instances of Windows in sandboxes.
• Website service: How to run a website in a virtual browser.
• SSL certificates: Add SSL certificates to your virtual machines.
• Cloud accounts
• Securing your cloud accounts
• Cloud Client
• AWS accounts: Give learners access to AWS accounts.
• AWS Environment Variables
• AWS Managed Policies
• AWS IAM Policies
• AWS SCP Policies
• Sharing AMIs with AWS Accounts
• Azure subscriptions: Give learners access to Azure subscriptions.
• Azure Environment Variables
• Azure Roles
• Azure Resource Providers
• GCP projects: Give learners access to GCP projects.
• GCP Environment Variables
• GCP IAM Permissions
• Lifecycle scripts
• Scripting overview: Introduction to scripting and how Instruqt leverages it.
• Track scripts: Add setup and cleanup scripts to your tracks
• Challenge scripts: Add setup, check, solve, and cleanup scripts to your challenges
• Example scripts: Example scripts that you can use in your lifecycle scripts.
• Helper scripts: Helper scripts are pre-written scripts to help implement lifecycle scripts.
• UI Checks
• Global Sandbox Settings
• Hot starts: Pre-provision sandboxes for instant access later on.
• Sandbox presets: How to create, publish, and use sandbox presets.
• Custom resources: How to create and use custom resources such as external cloud accounts and leverage them within your Instruqt sandbox.
• Cloud services and regions: How to configure services and regions that can be used later on in cloud accounts.
• Allowed services and regions: Complete list of cloud services and regions that can be configured in Instruqt.
• Secrets and variables
• Runtime variables: How to define runtime variables and use them inside lifecycle scripts or challenge assignments.
• Runtime parameters: Inject parameters at runtime to alter tracks.
• Secrets: How to use secrets in lifecycle scripts.
• Connect AI Models: Use AI models in your content via your cloud accounts
• Building with AI: Use AI tools in your workflow and in the product to create better training content, faster.
• Integrations
• Salesforce: Connect Instruqt with Salesforce to create hands-on lab invites directly from Opportunities and track prospect engagement in real-time.
• HubSpot: Integrate Instruqt with your HubSpot instance and enable options to create and enrich already existent contacts with track play information.
• HubSpot (Using zapier)
• LTI: Learn how to integrate Learning Tools Interoperability (LTI) with Instruqt.
• Version control: Learn how to integrate your version control system with Instruqt.
• GitHub: Here you'll learn how to integrate the version control feature with GitHub.
• Authentication
• SSO: Overview of SSO and how to implement it.
• Google Workspace
• Okta
• Azure AD (Entra ID)
• SAML
• API keys: How to generate an API key.
• Platform
• API: This reference describes the Instruqt GraphQL API and helps you get started.
• Webhooks: Let Instruqt automatically send track data to your system.
• Track limits: Control access to your tracks with limits.
• Feature overview
• Instruqt CLI
• Commands: Overview of Instruqt CLI commands.
• Configuration files: Learn about configuration files for editing locally.
• Assets: Overview of assets and how to use them.
• Instruqt platform
• Networking: Learn about the key aspects of networking in the Instruqt platform.
• Host machine types: List of available Google Cloud Compute Engine machine types with their characteristics.
• Quotas and limits
• Roles and permissions
• Client Requirements
• Network access
• Docker Hub registry mirror: Instruqt hosts a Docker Hub registry mirror to help with rate limits.
• Content design tips: Keep your learners engaged and happy.
• Advanced use cases
• Templates: What templates are and a list of available templates.
• Trust/Security
• Workshop Best Practices
• Hot Starts Best Practices: Tips and Best practices to properly plan and set the preprovisioned sandboxes pool size
• FAQ: Do you have questions about Instruqt?
• Running Windows Client Hosts on Instruqt
• Using Cleanup Scripts in SaaS and Cloud Environments
• Instruqt Regional Configurations and Restrictions
• Troubleshooting Instruqt CLI Authentication Issues
• Copy a Track from One Organization to Another via CLI
• Network Configuration: IP and MAC Address Control
• Container Troubleshooting in Instruqt

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.instruqt.com/getting-started/readme.md?ask=<question>

The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.