CalvinBackup/phishingclub
1
0
Fork 0
mirror of https://github.com/phishingclub/phishingclub.git synced 2026-02-12 16:12:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

add small feature overview

Browse Source 
Signed-off-by: Ronni Skansing <rskansing@gmail.com>
This commit is contained in:
Ronni Skansing
2025-08-21 22:22:07 +02:00
parent 90eef0ab4f
commit 144a5fb1d6
1 changed files with 42 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@@ -13,33 +13,31 @@ The self-hosted phishing framework for security awareness training and penetrati
Phishing Club is a phishing simulation framework designed for security professionals, red teams, and organizations looking to test and improve their security awareness. This platform provides tools for creating, deploying, and managing phishing campaigns in a controlled environment.
## License
Phishing Club is available under a dual licensing model:
### Open Source License (AGPL-3.0)
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This means:
- ✅ You can use, modify, and distribute the software freely
- ✅ Perfect for educational, research, and non-commercial use
- ✅ You can run your own instance for internal security testing
- ⚠️ **Important**: If you provide the software as a network service (SaaS), you must make your source code available under AGPL-3.0
### Commercial License
For organizations that want to:
- Use Phishing Club in commercial products without AGPL restrictions
- Offer Phishing Club as a service without source code disclosure
- Integrate with proprietary software
- Get dedicated support and maintenance
**Contact us for commercial licensing**: [license@phishing.club](mailto:license@phishing.club)
See the [LICENSE](LICENSE) file for the full AGPL-3.0 terms.
### Features
- Setup reusable phishing templates with emails, multiple phishing page flow, custom identifiers and more
- Advanced scheduling with time-boxed sending and daily schedules (like monday, wednesday between 08:00 and 16:00)
- API Sending, don't be limited by SMTP, deliver directly via an API
- Handle multiple domains with automatic TLS (https)
- Campaign overview and stats with graphs, per-recipient events and more
- Dashboard with company statistics, trendlines, calendar and overview
- Recipients and groups with stats such as repeat offender tracking
- Custom websites and 404 pages
- Asset management (upload js, css, images or whatever you want)
- Security features like MFA, audit logging, session management, IP locked sessions and more
- Webhooks for integrating with 3rd parties
- MSSP Ready with individual dashboard and etc. for each client.
- In-app updates
And lots lots more!
## Getting Started
### Production Installation
### Install
For production use, download the latest release and follow our installation guide:
Download the latest release and follow our installation guide:
1. **Download the latest version** from [GitHub Releases](https://github.com/phishingclub/phishingclub/releases)
2. **Follow the installation guide** at [https://phishing.club/guide/management/#install](https://phishing.club/guide/management/#install)
@@ -171,6 +169,27 @@ Key configuration options:
The development environment uses Pebble ACME server for automatic SSL certificate generation. In production, configure your preferred ACME provider or upload custom certificates.
## License
Phishing Club is available under a dual licensing model:
### Open Source License (AGPL-3.0)
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This means:
- ✅ You can use, modify, and distribute the software freely
- ✅ Perfect for educational, research, and non-commercial use
- ✅ You can run your own instance for internal security testing
- ⚠️ **Important**: If you provide the software as a network service (SaaS), you must make your source code available under AGPL-3.0
### Commercial License
For organizations that want to:
- Use Phishing Club in commercial products without AGPL restrictions
- Offer Phishing Club as a service without source code disclosure
- Integrate with proprietary software
- Get dedicated support and maintenance
**Contact us for commercial licensing**: [license@phishing.club](mailto:license@phishing.club)
## Contributing
We welcome contributions from the community! Please follow our contribution guidelines: