CipherSwarm User Guide#
Welcome to the CipherSwarm User Guide. This documentation covers everything you need to know to use CipherSwarm effectively, from initial setup to advanced attack configuration and troubleshooting.
Table of Contents#
Getting Started#
- Getting Started - First-time setup, dashboard overview, and your first campaign
Core Operations#
- Campaign Management - Creating, monitoring, and managing campaigns
- Attack Configuration - Configuring dictionary, mask, brute force, and hybrid attacks
- Understanding Results - Viewing, interpreting, and exporting cracking results
Agent Management#
- Agent Setup - Installing, registering, and configuring agents
- Agent Troubleshooting - Detailed agent diagnostics and task lifecycle troubleshooting
Resources#
- Resource Management - Managing wordlists, rule files, mask patterns, and charsets
Troubleshooting and Reference#
- Troubleshooting - System diagnostics, common issues, and solutions
- Common Issues - Quick fixes for frequently encountered problems
- FAQ - Frequently asked questions
Advanced Topics#
- Performance Optimization - Hardware tuning, attack strategies, and system optimization
- Web Interface - Complete web interface reference
- Air-Gapped Deployment - Deploying CipherSwarm in isolated environments
Quick Navigation#
| I want to... | Go to |
|---|---|
| Set up CipherSwarm for the first time | Getting Started |
| Create my first campaign | Getting Started |
| Register a new agent | Agent Setup |
| Configure an attack | Attack Configuration |
| View cracked hashes | Understanding Results |
| Upload wordlists or rules | Resource Management |
| Fix a problem | Troubleshooting |
| Check system health | Troubleshooting |
| Deploy in an air-gapped environment | Air-Gapped Deployment |
| Optimize performance | Performance Optimization |
What's New in V2#
CipherSwarm V2 introduces several new features for improved operational visibility and control:
Agent Monitoring#
Real-time agent status tracking with live hash rate monitoring, error badges, performance charts (8-hour trends), and detailed agent views with tabs for Overview, Errors, Configuration, and Capabilities. See Agent Setup.
Campaign Progress#
Enhanced campaign visualization with an attack stepper, progress bars with ETA display, a recent cracks feed, campaign error logs, and real-time updates via Turbo Streams. See Campaign Management.
Task Management#
New task detail views with inline actions for cancelling, retrying, and reassigning tasks directly from the web interface. Includes task status history and error handling. See Agent Troubleshooting.
System Health Dashboard#
A dedicated health monitoring page showing the status of PostgreSQL, Redis, MinIO, and the application itself. Includes real-time metrics, diagnostics information, and automatic refresh. See Troubleshooting.
Documentation Conventions#
Throughout this guide:
- Bold text indicates UI elements (buttons, menu items, labels)
Monospace textindicates commands, file paths, or configuration values- Indented code blocks show configuration examples or command output
- Links in square brackets reference other sections or guides
Getting Help#
If you cannot find an answer in this documentation:
- Check the FAQ for common questions
- Review Common Issues for quick fixes
- Consult the Troubleshooting guide for detailed diagnostics
- Visit the GitHub Issues page to report bugs or request features
