Skip to main content

​
Quickstart Guide

This guide will help you navigate the safesploitOrg documentation effectively and find the information you need quickly.

​
How to Navigate the Documentation

1

Identify Your Goal

Determine what you’re trying to accomplish:
  • Learning a new skill? → Start with Guides
  • Implementing something properly? → Check Best Practices
  • Understanding a production incident? → Review Case Studies
  • Meeting compliance requirements? → Explore Compliance
  • Quick command reference? → Jump to Cheatsheets
2

Use the Search Function

The documentation search is your fastest path to specific information:
  • Search for specific technologies (e.g., “nftables”, “LVM”, “AWS VPC”)
  • Search for concepts (e.g., “VLAN trunking”, “zero-trust”, “secrets management”)
  • Search for compliance frameworks (e.g., “NIST 800-53”, “Cyber Essentials+”)
3

Browse by Category

Use the sidebar navigation to explore content by category:
  • Best Practices — Organized by domain (Linux, Networking, Cloud & DevOps, Security)
  • Guides — Grouped by technology area with step-by-step instructions
  • Case Studies — Sorted chronologically by incident date
  • Compliance — Structured by framework and regulatory requirement
4

Follow Cross-References

Documentation pages link to related content:
  • Follow inline links to dive deeper into specific topics
  • Check “Related” sections at the end of pages
  • Use breadcrumbs to navigate back to parent sections

​
Quick Links to Popular Content

Linux Best Practices

Hardening, storage management, firewall configuration, and system observability

Networking Guides

VLAN trunking, CIDR notation, routing protocols (OSPF, BGP), and AWS VPC basics

Storage Management

LVM operations, Ceph networking, online resizing, and troubleshooting

Security Frameworks

NIST 800-53, ISO 27001, Cyber Essentials+, and CIS Benchmarks

AWS Incident Analysis

DNS bug in US-EAST-1 causing global DynamoDB endpoint failure

Azure Outage Study

Azure Front Door / CDN routing failure across multiple regions

Cloudflare Post-Mortem

Global outage from malformed bot-management configuration

Password Security

Creating strong, memorable passwords without password managers

​
Finding Specific Content Types

​
Guides (How-To)

Guides provide step-by-step instructions for specific tasks:
  • Linux Administration — RHEL9 nftables migration, system configuration
  • Networking — Subnetting with VLSM, route tables, VLAN configuration
  • Cloud & DevOps — AWS VPC setup, routing strategies
  • Security — Password creation, authentication hardening
Guides include code examples and command snippets you can copy and adapt for your environment.

​
Best Practices (Why & When)

Best practices explain the reasoning behind technical decisions:
  • Linux — Firewall rule management, storage configuration, observability patterns
  • Networking — Secure network segmentation, VLAN design, VPN setup
  • Cloud & DevOps — Infrastructure as Code, CI/CD security, container hardening
  • Security — Secrets management, MFA enforcement, audit logging
  • Documentation — Runbook writing, disaster recovery planning
Best practices combine technical implementation with operational context and security considerations.

​
Case Studies (Learn from Incidents)

Case studies analyze real-world outages and incidents:
  • Executive summaries for quick understanding
  • Technical root cause analysis with diagrams
  • Timelines showing how incidents unfolded
  • Impact assessments on services and users
  • Lessons learned for DevOps, DevSecOps, and SRE teams
  • Architecture diagrams illustrating failure modes
Case studies are based on public incident reports and are sanitized to focus on learning opportunities rather than blame.

​
Compliance Documentation

Compliance resources help align your infrastructure with industry standards:
  • Standards & Frameworks — NIST 800-53, ISO 27001, CIS Benchmarks
  • Policies — Access controls, backup policies, operational standards
  • Audits & Checklists — Self-assessment templates and readiness guides
  • Regulatory — GDPR, HIPAA, Cyber Essentials+ requirements

​
Cheatsheets (Quick Reference)

Cheatsheets provide concise command references:
  • AWK — Text processing and data extraction patterns
  • PowerShell — Common cmdlets and scripting patterns
  • More tools being added continuously

​
Tips for Using the Documentation Effectively

​
1. Start Broad, Then Narrow

Begin with overview pages (like /guides/overview or /best-practices/overview) to understand the landscape, then drill down into specific topics. Many topics span multiple sections. For example:
  • Firewall configuration appears in both Guides (how-to) and Best Practices (principles)
  • Storage management includes Linux guides, best practices, and troubleshooting

​
3. Learn from Real Incidents

Case studies provide context for why certain practices matter:
  • Read about AWS US-EAST-1 outages to understand DNS dependency risks
  • Study Azure CDN failures to learn about routing resilience
  • Analyze Cloudflare incidents to see configuration management importance

​
4. Bookmark Key References

Create bookmarks for pages you reference frequently:
  • CIDR notation tables
  • Compliance checklists
  • Command cheatsheets
  • Architecture decision records

​
5. Understand the “Why” Not Just the “How”

The documentation emphasizes reasoning behind decisions:
  • Why use nftables over iptables?
  • Why implement specific VLAN segmentation?
  • Why certain compliance controls matter?
Understanding the “why” helps you adapt practices to your specific context rather than blindly following instructions.

​
Documentation Structure Overview

safesploitOrg/docs/
├── architecture/       # High-level system designs
├── best-practices/    # Recommended patterns by domain
├── case-studies/      # Incident analysis and lessons
├── cheatsheets/       # Quick reference guides
├── compliance/        # Security frameworks and standards
├── guides/            # Step-by-step how-tos
├── repo/              # Per-repository documentation
└── templates/         # Reusable documentation templates

​
Content Organization Principles

By Domain

Content is organized by technical domain (Linux, Networking, Cloud, Security) making it easy to find related information.

By Use Case

Multiple entry points exist for the same content — find information by what you’re trying to accomplish.

Cross-Linked

Heavy use of internal links connects related concepts and creates learning paths through the documentation.

Public-Safe

All content is sanitized to share knowledge without exposing sensitive implementation details or credentials.

​
Next Steps

Now that you understand how to navigate:

Explore Best Practices

Start with foundational practices in Linux and systems, then expand to cloud and DevOps.

Read a Guide

Pick a technical guide that matches your current learning goals or project needs.

Study an Incident

Learn from real-world outages at major cloud providers and what they teach us.

Check Compliance

Review security frameworks and regulatory requirements relevant to your environment.
Pro tip: Use the documentation search with specific keywords like technology names, error messages, or compliance control numbers for fastest results.

Build docs developers (and LLMs) love

Get started for freeTalk to us