LogoLogo
HomeAPIBlog
3.0.0-SNAPSHOT
3.0.0-SNAPSHOT
  • INTRODUCTION
    • Getting Started
      • Running Local Development Servers
      • Beginner Tutorial: Hello World
      • Beginner Tutorial: Hello Database
      • Tutorial: Wheels, AJAX, and You
    • Frameworks and Wheels
    • Requirements
    • Manual Installation
    • Upgrading
    • Screencasts
  • Command Line Tools
    • CLI Overview
    • Quick Start Guide
    • Command Reference
      • Core Commands
        • wheels init
        • wheels info
        • wheels reload
        • wheels deps
        • wheels destroy
        • wheels watch
      • Code Generation
        • wheels generate app
        • wheels generate app-wizard
        • wheels generate controller
        • wheels generate model
        • wheels generate view
        • wheels generate property
        • wheels generate route
        • wheels generate resource
        • wheels generate api-resource
        • wheels generate frontend
        • wheels generate test
        • wheels generate snippets
        • wheels scaffold
      • Database Commands
        • wheels dbmigrate info
        • wheels dbmigrate latest
        • wheels dbmigrate up
        • wheels dbmigrate down
        • wheels dbmigrate reset
        • wheels dbmigrate exec
        • wheels dbmigrate create blank
        • wheels dbmigrate create table
        • wheels dbmigrate create column
        • wheels dbmigrate remove table
        • wheels db schema
        • wheels db seed
      • Testing Commands
        • wheels test
        • wheels test run
        • wheels test coverage
        • wheels test debug
      • Configuration Commands
        • wheels config list
        • wheels config set
        • wheels config env
      • Environment Management
        • wheels env
        • wheels env setup
        • wheels env list
        • wheels env switch
      • Plugin Management
        • wheels plugins
        • wheels plugins list
        • wheels plugins install
        • wheels plugins remove
      • Code Analysis
        • wheels analyze
        • wheels analyze code
        • wheels analyze performance
        • wheels analyze security
      • Security Commands
        • wheels security
        • wheels security scan
      • Performance Commands
        • wheels optimize
        • wheels optimize performance
      • Documentation Commands
        • wheels docs
        • wheels docs generate
        • wheels docs serve
      • CI/CD Commands
        • wheels ci init
      • Docker Commands
        • wheels docker init
        • wheels docker deploy
      • Deployment Commands
        • wheels deploy
        • wheels deploy audit
        • wheels deploy exec
        • wheels deploy hooks
        • wheels deploy init
        • wheels deploy lock
        • wheels deploy logs
        • wheels deploy proxy
        • wheels deploy push
        • wheels deploy rollback
        • wheels deploy secrets
        • wheels deploy setup
        • wheels deploy status
        • wheels deploy stop
    • CLI Development Guides
      • Creating Commands
      • Service Architecture
      • Migrations Guide
      • Testing Guide
  • Working with Wheels
    • Conventions
    • Configuration and Defaults
    • Directory Structure
    • Switching Environments
    • Testing Your Application
    • Using the Test Environment
    • Contributing to Wheels
    • Submitting Pull Requests
    • Documenting your Code
  • Handling Requests with Controllers
    • Request Handling
    • Rendering Content
    • Redirecting Users
    • Sending Files
    • Sending Email
    • Responding with Multiple Formats
    • Using the Flash
    • Using Filters
    • Verification
    • Event Handlers
    • Routing
    • URL Rewriting
      • Apache
      • IIS
      • Tomcat
      • Nginx
    • Obfuscating URLs
    • Caching
    • Nesting Controllers
    • CORS Requests
  • Displaying Views to Users
    • Pages
    • Partials
    • Linking Pages
    • Layouts
    • Form Helpers and Showing Errors
    • Displaying Links for Pagination
    • Date, Media, and Text Helpers
    • Creating Custom View Helpers
    • Localization
  • Database Interaction Through Models
    • Object Relational Mapping
    • Creating Records
    • Reading Records
    • Updating Records
    • Deleting Records
    • Column Statistics
    • Dynamic Finders
    • Getting Paginated Data
    • Associations
    • Nested Properties
    • Object Validation
    • Object Callbacks
    • Calculated Properties
    • Transactions
    • Dirty Records
    • Soft Delete
    • Automatic Time Stamps
    • Database Migrations
      • Migrations in Production
    • Using Multiple Data Sources
  • Plugins
    • Installing and Using Plugins
    • Developing Plugins
    • Publishing Plugins
  • Project Documentation
    • Overview
  • External Links
    • Source Code
    • Issue Tracker
    • Sponsor Us
    • Community
Powered by GitBook
LogoLogo
On this page
  • Synopsis
  • Description
  • Options
  • Examples
  • Basic audit
  • Audit staging environment
  • Generate HTML report
  • Show only high severity issues
  • Auto-fix issues
  • Audit Checks
  • Security
  • Configuration
  • Compliance
  • Output
  • Use Cases
  • Pre-deployment audit
  • Scheduled audits
  • Compliance reporting
  • Best Practices
  • Integration
  • See Also

Was this helpful?

Edit on GitHub
Export as PDF
  1. Command Line Tools
  2. Command Reference
  3. Deployment Commands

wheels deploy audit

Audit deployment configuration and security settings to ensure compliance and best practices.

Synopsis

wheels deploy audit [options]

Description

The wheels deploy audit command performs a comprehensive security and configuration audit of your deployment setup. It checks for common misconfigurations, security vulnerabilities, and compliance issues in your deployment environment.

Options

  • --environment, -e - Target environment to audit (default: production)

  • --report-format - Output format for audit report (json, html, text) (default: text)

  • --output, -o - Save audit report to file

  • --severity - Minimum severity level to report (low, medium, high, critical)

  • --fix - Attempt to automatically fix issues where possible

  • --verbose, -v - Show detailed audit information

Examples

Basic audit

wheels deploy audit

Audit staging environment

wheels deploy audit --environment staging

Generate HTML report

wheels deploy audit --report-format html --output audit-report.html

Show only high severity issues

wheels deploy audit --severity high

Auto-fix issues

wheels deploy audit --fix

Audit Checks

The command performs the following audit checks:

Security

  • SSL/TLS configuration

  • Exposed sensitive files

  • Default credentials

  • Authentication mechanisms

  • Authorization settings

  • Input validation

  • Session management

  • Error handling

Configuration

  • Environment variables

  • Database connections

  • API endpoints

  • File permissions

  • Resource limits

  • Logging configuration

  • Backup settings

  • Monitoring setup

Compliance

  • Data protection requirements

  • Access control policies

  • Audit trail completeness

  • Retention policies

  • Encryption standards

Output

The audit generates a detailed report including:

  • Summary of findings

  • Issue severity levels

  • Affected components

  • Remediation recommendations

  • Compliance status

  • Performance metrics

Use Cases

Pre-deployment audit

# Run comprehensive audit before deploying
wheels deploy audit --severity low
wheels deploy push --if-audit-passes

Scheduled audits

# Run regular audits in CI/CD
wheels deploy audit --output reports/audit-$(date +%Y%m%d).json

Compliance reporting

# Generate compliance report
wheels deploy audit --report-format html --output compliance.html

Best Practices

  1. Regular audits: Run audits regularly, not just before deployments

  2. Fix critical issues: Always address critical and high severity issues

  3. Document exceptions: Keep records of accepted risks and exceptions

  4. Automate checks: Integrate audits into your CI/CD pipeline

  5. Review reports: Have security team review audit reports

Integration

The audit command integrates with:

  • CI/CD pipelines for automated security checks

  • Monitoring systems for continuous compliance

  • Issue tracking systems for remediation workflow

  • Reporting tools for compliance documentation

See Also

Previouswheels deployNextwheels deploy exec

Last updated 2 days ago

Was this helpful?

- Check deployment status

- Run security scans

- Setup deployment environment

deploy status
security scan
deploy setup