Skip to content

Ruphish documentation

Ruphish helps you prepare phishing simulations, deliver personalized messages, and understand the resulting observations. Choose the guide that matches what you want to do.

Your goalStart here
Try Ruphish for the first timeGetting started
Create content or run a campaignUser guide
Configure or maintain an installationAdministration
Automate a workflow or receive eventsHTTP API
Bring an existing Gophish installation acrossMigration
Work on the code or documentationContributing

Start with installation for the release binary and Docker image, or follow the local campaign tutorial for a contained exercise.

TODO before publication: Release binaries and the Docker image are not available yet. Complete and verify both installation paths before publishing these docs.

Already familiar with Gophish? Read what changes before reusing configuration, templates, or scripts.