Quick Start
Get started with SnapBench in 5 minutes.
For Participants
1. Join an Organization
You'll receive an invitation link from your instructor or admin. Click it to create your account and join the organization.
TIP
If you're joining an existing organization, your membership may require admin approval before you can access scenarios.
2. Browse Available Scenarios
Once your membership is active, navigate to your Dashboard to see available scenarios.
3. Start a Lab
- Click Start Lab on any published scenario
- Wait for the environment to provision (usually 1-2 minutes)
- Click Access Lab when ready
4. Complete the Lab
- Follow the instructions in the right sidebar
- Use tab navigation links to switch between components
- Run commands in terminals
- Access web UIs for visual tools
5. Stop the Lab
When finished, click Stop Lab. Your environment will be cleaned up automatically.
For Authors
1. Access the Studio
Navigate to Scenarios and click New Scenario.
2. Add Components
In the Canvas tab:
- Click Add Component
- Browse the catalog
- Select components (Kafka, PostgreSQL, etc.)
- Configure resources and settings
3. Write Instructions
In the Instructions tab:
- Click Add Instruction
- Write markdown content
- Use code blocks with copy buttons
- Add tab navigation links:
[Open Kafka](tab:kafka)
4. Publish
- Review in Preview tab
- Click Publish New Version
- Add release notes
Your scenario is now available to participants!
For Admins
1. Create an Organization
When you register, you automatically become the admin of a new organization.
2. Invite Users
Navigate to Organization Settings > Users:
- Click Invite User
- Enter email address
- Select role (admin, author, or participant)
3. Configure Quotas
Set resource limits for your organization:
- Maximum concurrent runs
- CPU and memory limits per run
- Lab TTL (time-to-live)
Next Steps
- Core Concepts - Understand the platform architecture
- Admin Guide - Set up your organization
- Author Guide - Master the Studio