Step 1 - Project Setup
Creating Your Lab
Section titled “Creating Your Lab”Labs can be accessed in the Labs section of the menu. All your labs are listed on this page. To create a new lab, click the Create lab button in the top right corner and choose From a template. This option also covers empty labs. To have the AI assistant draft a lab instead, choose With AI (see Generating a lab).
The Create lab dialog asks for three things:
- Title: the title users see when they open the lab. Let’s use
My Web Server Lab. - Lab name: the lab’s unique identifier, used in the lab’s URL. Each version can have its own title, but the name stays the same across all versions.
- Template: what the lab starts from. The default, From scratch, creates an empty lab. Your team’s templates appear in the dropdown’s Default and Team sections. To make a lab into a template, mark it as one in its Project settings. It then appears in this dropdown for everyone on the team.
The title and name don’t need to match, and both can be changed later. For now, we’ll keep them as they are. Click Create lab to create the lab.
Version Control and Tracking
Section titled “Version Control and Tracking”Every lab is versioned, so all changes are automatically recorded. This ensures you can review the history of your lab and see exactly what has changed over time.
Safe, Isolated Editing
Section titled “Safe, Isolated Editing”When you make updates, they happen in your own isolated environment. This allows you to review and test changes before saving them to the main lab, keeping the original version safe from accidental modifications.
Collaboration and Conflict Resolution
Section titled “Collaboration and Conflict Resolution”Multiple users can work on separate branches simultaneously. If conflicting changes arise, they can be reviewed and resolved before merging, ensuring smooth collaboration.
Versions and Releases
Section titled “Versions and Releases”You can create versions or release tags to mark important milestones in your lab. For example, you might tag a “v1.0” version for the first stable release, a “workshop-2025” version for a training session, or a “beta-feature” version for experimental updates. You can also maintain separate versions for different software updates—for instance, one version of your lab could be set up for version 2.0 of a software, while another version is prepared for version 3.0. This approach allows you to manage multiple stages of your lab simultaneously, easily switch between versions, and track its evolution over time.
The title of a lab can be customized for each version, giving each iteration its own identity, while the lab’s name remains unique across all versions. This is the name that will be used in the urls when accessing your lab.
Read more
Section titled “Read more”You can also use your own GitHub repository to start your lab. See the Getting Started (Code flow) to learn more.
Importing Your Lab
Section titled “Importing Your Lab”If the lab already exists in a GitHub repository, import it instead of creating it here. Your organization needs the GitHub integration set up first.
See Importing a lab from a repository for the dialog and its fields, and Setting up the GitHub integration for the one-time account setup.
Duplicating a Lab
Section titled “Duplicating a Lab”To start from a lab you already have, duplicate it, either in your own team or in another team you build labs in. On the Labs page, open the actions menu (⋮) at the end of the lab’s row and choose Duplicate. The menu is only shown to Owners and Content Creators.
The Duplicate lab dialog asks for four things:
- Title: prefilled with the original’s title.
- Lab name: prefilled with the original’s name. Lab names are unique within a team, so while the original’s own team is selected the field reports
A lab named "<name>" already exists.Give the copy a new name, or pick another team where the name is free. Once you edit the title, the name follows it, until you edit the name yourself. - Team: the team the copy is created in. It starts on the lab’s own team, marked Current, and lists every team where you are an Owner or a Content Creator.
- Reference: the branch to copy. It defaults to the lab’s default branch, marked Default.
Click Duplicate lab to create the copy. It opens in edit mode.
What the copy contains
Section titled “What the copy contains”The copy is a new lab with its own repository. It gets the lab’s files on the selected branch as they were last published, committed to its main branch as a single commit, with the new title written into its lab resource. It does not get:
- The original’s change history or its other branches.
- Changes that are still unpublished in an editing session.
- The original’s connection to a GitHub repository. The copy uses Instruqt’s native version control; connect it separately if you need to.
- The original’s tags, template status or maintenance mode.
Labs that use private modules
Section titled “Labs that use private modules”A private module can only be used by the team that owns it. If the selected branch uses a module that is private to a team other than the one you picked, the dialog shows This lab uses modules that are private to their team, so it can't be duplicated into <team>:, lists each module as <module address> (private to <team-slug>), and keeps Duplicate lab disabled.
To go ahead, pick the team that owns the module, if you build labs in it, or have that team make the module Public in its settings first. When the modules are private to different teams, pick one of those teams you build labs in, and have the others make their modules Public.
If a module the branch uses no longer exists, the dialog shows a warning: These modules could not be found and may stop the duplicate from being created: followed by their addresses. You can still try to duplicate the lab.
What’s Next
Section titled “What’s Next”In the next step, you’ll define the infrastructure that powers your lab by creating containers, networks, and user interface elements that users will interact with.
