Documentation

Lab Documentation

Documentation is an important step in the lab building process. It helps users of your lab environments understand the systems, software, and scenarios you've built into the lab.

Snap Labs provides two methods to easily document your lab details as you build: Markdown Style Readme's and Uploaded Files.

Creating Markdown Documentation

Every newly launched lab is deployed with a sample readme. This will help you quickly get started with markdown syntax and provide suggested details to include in your documentation.

Consider documenting the following in this markdown section:

  • System Details
    • Hostnames
    • IP Addresses
    • Credentials
    • Users Sessions
  • Active Directory Details
    • Trust Relationships
    • Important Users and Passwords
  • Additional System Details
    • Descriptions
    • Other User Accounts
    • Configured Software

Admin and Student Readme Versions

Snap Labs is designed to make it easy to hold training events, CTFs, hiring assessments, and other events where you might not want the participants to have all the lab details. However, most likely you'll want them to have some details about the lab or event.

To support this scenario, we've made it easy to create separate documentation for Admin and Student users. While editing the Readme documentation, select the Different readme for students/admins radio button. This will automatically create separate pages which you can maintain with different lab information.

Uploading Documentation Files

In some cases, specific files are better suited for pieces of the lab documentation. For instance, if you are building a training environment which already has a set of PowerPoint slides, you might want to upload the slides and associate them with your lab template.

To upload a standalone file, navigate to the Files tab and provide a Document Name, Document Description, and then Choose File. You can also choose to allow students to access these files or reserve them for lab administrators.


What’s Next