Range Documentation

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

Cyber Ranges provides two methods to easily document your range details as you build: Markdown style Documentation (Readme's) and Uploaded Files.

Creating Markdown Documentation

Every newly launched range 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 noting the following in your markdown documentation:

  • 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

Markdown Documentation Versions: Readme and Admin Readme

Cyber Ranges 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 range details. However, in other cases, it's likely you'll want them to have some details about the range or event.

To support this scenario, we've made it easy to create separate documentation for Admin users. Whilst editing the Readme documentation, select the readme/Admin readme radio button to automatically create separate pages for your individual users and Admins which you can maintain with different range information. This allows you to target your users with the documentation that is relevant to them. You could of course choose to not split your documentation up; in this case, you'll have a single readme for all your users.

Uploading Documentation Files

In some cases, specific files are better suited for pieces of the range 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 range 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 range administrators.

What’s Next