mirror of
https://github.com/cliffe/HacktivityLabSheets.git
synced 2026-02-20 13:50:46 +00:00
Add configuration files and enhance lab content
- Introduced a new local configuration file (_config_local.yml) for local development. - Updated Gemfile to include 'webrick' for Ruby 3.0+ compatibility and removed specific version constraints for 'github-pages'. - Created a new Gemfile.local for local development with updated dependencies. - Added multiple new lab sheets covering topics such as scanning, exploitation, and vulnerability analysis, enhancing the educational content. - Improved lab layout and content presentation, including enhanced syntax highlighting and image handling. - Added various images to support the new lab content and improve visual learning.
This commit is contained in:
111
README.md
111
README.md
@@ -1,41 +1,50 @@
|
||||
# HacktivityLabSheets
|
||||
|
||||
Lab sheets for Hacktivity SecGen labs - A collection of hands-on cybersecurity lab exercises.
|
||||
**Contribute to Hacktivity Cyber Security Labs** - This repository contains the source lab sheets for [Hacktivity Cyber Security Labs](https://hacktivity.co.uk), a comprehensive cyber security education platform.
|
||||
|
||||
## 🌐 Live Site
|
||||
## 🎯 About This Repository
|
||||
|
||||
Visit the lab sheets at: **https://cliffe.github.io/HacktivityLabSheets**
|
||||
This repository serves as the **contribution hub** for lab content used by [Hacktivity Cyber Security Labs](https://hacktivity.co.uk). The lab sheets are designed to work with SecGen (Security Scenario Generator) to create vulnerable virtual machines for hands-on cybersecurity education.
|
||||
|
||||
## 🌐 Live Sites
|
||||
|
||||
- **Hacktivity Cyber Security Labs**: [https://hacktivity.co.uk](https://hacktivity.co.uk) - The main platform where students access and complete labs
|
||||
- **Lab Sheets Preview**: [https://cliffe.github.io/HacktivityLabSheets](https://cliffe.github.io/HacktivityLabSheets) - Preview of lab content for contributors
|
||||
|
||||
## 📚 Available Labs
|
||||
|
||||
This repository contains practical cybersecurity lab exercises designed for educational purposes. Each lab includes:
|
||||
This repository contains practical cyber security lab exercises designed for educational purposes, covering topics from Linux fundamentals to advanced exploitation techniques.
|
||||
|
||||
- Step-by-step instructions
|
||||
- Learning objectives
|
||||
- Prerequisites
|
||||
- Expected duration
|
||||
- Hands-on exercises with real tools
|
||||
- Analysis questions
|
||||
- Additional challenges
|
||||
## 🚀 Getting Started
|
||||
|
||||
### Current Lab Topics
|
||||
### For Leaners/Hackers
|
||||
1. Visit [Hacktivity Cyber Security Labs](https://hacktivity.co.uk) to access the full platform
|
||||
2. Sign up for an account to start completing labs
|
||||
3. Use the lab sheets in this repository as reference material
|
||||
|
||||
- **Network Scanning**: Learn reconnaissance techniques with Nmap
|
||||
- **Web Application Security**: Vulnerability assessment with OWASP ZAP
|
||||
- **Digital Forensics**: Incident response and evidence analysis
|
||||
- More labs are continuously being added!
|
||||
|
||||
## 🚀 Using the Labs
|
||||
|
||||
1. Visit the [live site](https://cliffe.github.io/HacktivityLabSheets) to browse available labs
|
||||
2. Click on any lab title to view detailed instructions
|
||||
3. Follow the setup and execution steps provided
|
||||
4. Complete the exercises and answer the analysis questions
|
||||
### For Contributors
|
||||
1. Fork this repository to contribute lab sheet improvements (and see SecGen for the software components of challenges)
|
||||
2. Follow the contribution guidelines below
|
||||
3. Use the automated setup script (`./start-server-github-pages.sh`) for easy local development
|
||||
4. Submit pull requests to improve existing labs or add new ones
|
||||
|
||||
## 🛠 Local Development
|
||||
|
||||
To run the site locally for development:
|
||||
|
||||
### Quick Start (Recommended)
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/cliffe/HacktivityLabSheets.git
|
||||
cd HacktivityLabSheets
|
||||
|
||||
# Run the automated setup script (GitHub Pages compatible)
|
||||
./start-server-github-pages.sh
|
||||
|
||||
# Visit http://localhost:4000 in your browser
|
||||
```
|
||||
|
||||
### Manual Setup
|
||||
```bash
|
||||
# Install Jekyll (if not already installed)
|
||||
gem install bundler jekyll
|
||||
@@ -53,10 +62,17 @@ bundle exec jekyll serve
|
||||
# Visit http://localhost:4000 in your browser
|
||||
```
|
||||
|
||||
## 📝 Contributing New Labs
|
||||
## 📝 Contributing to Hacktivity Labs
|
||||
|
||||
We welcome contributions of new lab exercises! To add a new lab:
|
||||
We welcome contributions to improve and expand the lab content used by Hacktivity Cyber Security Labs! You can:
|
||||
|
||||
- **Improve existing labs**: Fix errors, clarify instructions, add better explanations
|
||||
- **Add new labs**: Create new exercises covering additional cybersecurity topics
|
||||
- **Update content**: Keep lab content current with latest tools and techniques
|
||||
|
||||
### How to Contribute
|
||||
|
||||
#### For New Labs
|
||||
1. Create a new markdown file in the `_labs/` directory
|
||||
2. Use the following front matter template:
|
||||
|
||||
@@ -64,9 +80,6 @@ We welcome contributions of new lab exercises! To add a new lab:
|
||||
---
|
||||
title: "Lab X: Your Lab Title"
|
||||
description: "Brief description of what the lab covers"
|
||||
difficulty: "Beginner/Intermediate/Advanced"
|
||||
duration: "X minutes"
|
||||
prerequisites: "Required background knowledge"
|
||||
tags: ["tag1", "tag2", "tag3"]
|
||||
---
|
||||
```
|
||||
@@ -74,37 +87,47 @@ tags: ["tag1", "tag2", "tag3"]
|
||||
3. Write your lab content using markdown
|
||||
4. Test locally before submitting a pull request
|
||||
|
||||
#### For Improving Existing Labs
|
||||
1. Browse existing labs in the `_labs/` directory
|
||||
2. Make improvements to content, clarity, or accuracy
|
||||
3. Test your changes locally
|
||||
4. Submit a pull request with a clear description of improvements
|
||||
|
||||
### Lab Content Guidelines
|
||||
|
||||
- **Clear Objectives**: Start with what students will learn
|
||||
- **Prerequisites**: List required background knowledge
|
||||
- **Step-by-Step Instructions**: Provide detailed, testable steps
|
||||
- **Questions and Analysis**: Include thought-provoking questions
|
||||
- **Safety Warnings**: Always emphasize ethical use and authorization
|
||||
- **Resources**: Link to additional learning materials
|
||||
- **Proper Highlighting**: Use the highlighting system for better readability
|
||||
|
||||
## ⚠️ Ethical Use
|
||||
### Highlighting System
|
||||
|
||||
All lab exercises are designed for educational purposes in controlled environments. Users must:
|
||||
This repository uses a special highlighting system to make lab content more readable and actionable. See the [Example Highlighting Guide](_labs/example_highlighting_guide.md) for comprehensive instructions on:
|
||||
|
||||
- Only practice on systems they own or have explicit permission to test
|
||||
- Follow all applicable laws and regulations
|
||||
- Respect terms of service and acceptable use policies
|
||||
- Use knowledge gained responsibly and ethically
|
||||
- How to properly highlight actions, tips, hints, and warnings
|
||||
- Formatting commands and code blocks
|
||||
- Using VM context indicators
|
||||
- Creating effective question and flag blocks
|
||||
- Best practices for lab sheet formatting
|
||||
|
||||
**Important**: When contributing to existing labs, follow the highlighting patterns established in the guide to maintain consistency across all lab sheets.
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## 🤝 Support
|
||||
## 🤝 Support & Community
|
||||
|
||||
If you encounter issues or have questions:
|
||||
### For Learners / Hackers
|
||||
- Visit [Hacktivity Cyber Security Labs](https://hacktivity.co.uk) for the full learning platform
|
||||
- Check lab instructions carefully before seeking help
|
||||
- Join the Hacktivity Discord server for community support
|
||||
|
||||
1. Check the lab instructions carefully
|
||||
2. Review the prerequisites
|
||||
3. Open an issue on GitHub with detailed information
|
||||
4. Join the discussion in our community forums
|
||||
### For Contributors
|
||||
- Open an issue on GitHub for bugs or feature requests
|
||||
- Join discussions about lab improvements
|
||||
|
||||
## 🎯 About SecGen
|
||||
|
||||
These labs are designed to work with [SecGen (Security Scenario Generator)](https://github.com/cliffe/SecGen), which creates vulnerable virtual machines for security education and training.
|
||||
Hacktivty is powerd by our open source [SecGen (Security Scenario Generator)](https://github.com/cliffe/SecGen), which creates vulnerable virtual machines for security education and training.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user