Skip to content
Jean-Marc Strauven edited this page Aug 1, 2025 · 2 revisions

🏠 Laravel Safeguard Wiki

πŸ›‘οΈ Configurable Security Checks for Laravel Applications

Welcome to the comprehensive documentation for Laravel Safeguard β€” a powerful Laravel package that provides configurable security checks for your applications. Run safety audits on environment variables, configuration files, and hidden routes to prevent common mistakes before going live.

🌟 What is Laravel Safeguard?

Laravel Safeguard is a modern security auditing package for Laravel that acts like Pint, PHPStan, or Rector but for security and configuration auditing. It provides:

β€’ πŸ”§ Configurable Rules System β€” Enable/disable security checks via config/safeguard.php
β€’ πŸ” Environment Security β€” Verify .env files, detect secrets in code, validate required keys
β€’ βš™οΈ Application Configuration β€” Check Laravel-specific security settings
β€’ πŸ›‘οΈ Production Safety β€” Prevent common production mistakes before deployment
β€’ πŸ“Š Multiple Output Formats β€” CLI, JSON, or CI-friendly reporting
β€’ πŸš€ CI/CD Integration β€” Perfect for GitHub Actions, GitLab CI, and other pipelines

πŸš€ Quick Navigation

🎯 Getting Started

Perfect for newcomers to Laravel Safeguard

β€’ πŸ“¦ Installation Guide - Installation, configuration, and setup
β€’ ⚑ Quick Start Guide - Get running in minutes with your first security check
β€’ πŸ’‘ Examples Collection - Complete working examples and templates
β€’ βš™οΈ Configuration Guide - How to configure security rules for your application

πŸ“š Core Documentation

Essential guides for mastering Laravel Safeguard

β€’ πŸ“ Rules Reference - Complete security rules documentation
β€’ πŸ”§ Commands Reference - All available Artisan commands
β€’ 🌍 Environment Rules - Environment-specific security rules
β€’ πŸ—οΈ Custom Rules - Creating your own security rules

πŸ”§ Advanced Features

For power users and complex scenarios

β€’ πŸ“Š Output Formats - JSON, CLI, and custom output formats
β€’ πŸš€ CI/CD Integration - GitHub Actions, GitLab CI, and pipeline integration
β€’ ⚑ Performance Optimization - Optimizing security checks for large applications
β€’ πŸ“– API Reference - Programmatic usage and API documentation

πŸ› οΈ Support & Troubleshooting

For debugging and getting help

β€’ πŸ†˜ Troubleshooting - Common issues and solutions
β€’ ❓ FAQ - Frequently asked questions
β€’ πŸ”„ Migration Guide - Upgrading between versions

πŸŽ“ Learning Paths

πŸ‘Ά Beginner Path

Start here if you're new to Laravel Safeguard

  1. πŸ“¦ Installation Guide - Install and set up the package
  2. ⚑ Quick Start - Run your first security check
  3. πŸ’‘ Examples Collection - Explore basic examples
  4. βš™οΈ Configuration Guide - Learn to configure rules

πŸ‘¨β€πŸ’» Intermediate Path

Ready to dive deeper?

  1. πŸ“ Rules Reference - Master all security rules
  2. 🌍 Environment Rules - Environment-specific configurations
  3. πŸš€ CI/CD Integration - Add to your deployment pipeline
  4. πŸ“Š Output Formats - Customize output for your needs

πŸš€ Advanced Path

Become a Laravel Safeguard expert

  1. πŸ—οΈ Custom Rules - Create custom security rules
  2. πŸ“– API Reference - Programmatic usage
  3. ⚑ Performance Optimization - Optimize for large applications
  4. πŸ†˜ Troubleshooting - Handle complex scenarios

πŸ” Quick Reference

Topic Page Description
Quick Start Quick Start Installation and first security check
Examples Examples Collection Working examples and templates
Rules Rules Reference Complete security rules reference
Commands Commands All available CLI commands
Configuration Configuration Configuration options and patterns
CI/CD CI/CD Integration Pipeline integration
Custom Rules Custom Rules Creating custom security rules
Troubleshooting Troubleshooting Error handling and debugging

πŸ’‘ Popular Use Cases

πŸ”₯ Most Common

β€’ Pre-deployment security checks β†’ Quick Start Guide
β€’ Environment validation β†’ Environment Rules
β€’ CI/CD pipeline integration β†’ CI/CD Integration

🎯 Security Auditing

β€’ Production readiness checks β†’ Rules Reference
β€’ Configuration validation β†’ Configuration Guide
β€’ Custom security policies β†’ Custom Rules

⚑ Advanced Integration

β€’ Programmatic security checks β†’ API Reference
β€’ Custom output formats β†’ Output Formats
β€’ Performance optimization β†’ Performance Guide

🀝 Community & Support

β€’ πŸ“‹ Main Documentation: Complete guides and references available in this wiki
β€’ πŸ’‘ Examples: Extensive examples collection with real-world use cases
β€’ πŸ› Issues: Report bugs and request features on the main repository
β€’ πŸ’¬ Discussions: Join the community discussions for questions and tips

πŸš€ Ready to get started?

πŸ“¦ Start with the Installation Guide or explore our πŸ’‘ Examples Collection

Secure your Laravel applications today with Laravel Safeguard!


Laravel Safeguard - Configurable Security Checks for Laravel Applications

🏠 Home | πŸ“¦ Installation | ⚑ Quick Start | πŸ’‘ Examples | πŸ“š Full Docs

Made with ❀️ for the Laravel community

Clone this wiki locally