2016-01-08 01:35:15 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
|
|
|
|
|
<head>
|
2017-09-18 13:48:23 +00:00
|
|
|
<title>
|
|
|
|
|
Documentation - Gophish
|
|
|
|
|
</title>
|
|
|
|
|
<meta charSet="utf-8">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
|
|
|
|
<meta name="description" content="Gophish Documentation - Includes the API documentation, user guide, and development documentation">
|
2016-01-08 01:35:15 +00:00
|
|
|
<meta name="author" content="Jordan Wright">
|
2017-09-18 13:48:23 +00:00
|
|
|
<meta name="keywords" content="gophish documentation, gophish, gophish user guide, phishing framework, phishing toolkit, open source phishing">
|
|
|
|
|
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="/build/css/build.css">
|
|
|
|
|
<script defer src="/build/js/build.min.js"></script>
|
2016-01-08 01:35:15 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
2017-09-18 13:48:23 +00:00
|
|
|
<nav class="navbar navbar-expand-lg navbar-dark bg-purple">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<a class="navbar-brand" href="/">
|
2017-10-22 13:55:09 +00:00
|
|
|
<img src="/img/logo.min.svg" width="30" height="30" class="d-inline-block align-top" alt="">
|
2017-09-18 13:48:23 +00:00
|
|
|
<strong>Gophish</strong>
|
|
|
|
|
</a>
|
2018-09-23 22:02:03 +00:00
|
|
|
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarContent"
|
|
|
|
|
aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
|
2017-09-18 13:48:23 +00:00
|
|
|
<span class="navbar-toggler-icon"></span>
|
|
|
|
|
</button>
|
2016-01-08 01:35:15 +00:00
|
|
|
|
2017-09-18 13:48:23 +00:00
|
|
|
<div class="collapse navbar-collapse" id="navbarContent">
|
|
|
|
|
<ul class="navbar-nav ml-auto">
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a class="nav-link active" href="/documentation">Documentation</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a target="_blank" class="nav-link" href="https://github.com/gophish/gophish/issues">Support</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a class="nav-link" href="/blog">Blog</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a class="mt-1 ml-md-1 btn btn-primary" href="https://github.com/gophish/gophish/releases">Download</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</nav>
|
|
|
|
|
<div class="mt-5 feature">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<div class="row text-center">
|
|
|
|
|
<div class="col-12">
|
|
|
|
|
<h3 class="heading">
|
|
|
|
|
Documentation
|
|
|
|
|
</h3>
|
2016-01-08 01:35:15 +00:00
|
|
|
</div>
|
2017-09-18 13:48:23 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="row mb-4 justify-content-center">
|
|
|
|
|
<div class="card doc-card">
|
|
|
|
|
<div class="mt-4 d-flex justify-content-center section-media">
|
|
|
|
|
<span class="fa-layers fa-fw">
|
|
|
|
|
<i class="fal fa-book section-icon"></i>
|
|
|
|
|
</span>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="card-body">
|
|
|
|
|
<h4 class="card-title text-center">User Guide</h4>
|
2018-09-23 22:02:03 +00:00
|
|
|
<p class="card-text">Learn how to install, configure, and use Gophish to test your
|
|
|
|
|
organization's exposure to phishing.</p>
|
2017-09-18 13:48:23 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="card-footer d-flex justify-content-center">
|
2018-09-23 22:02:03 +00:00
|
|
|
<a target="_blank" class="btn-lg btn-feature btn" href="https://docs.getgophish.com/user-guide/">Read</a>
|
2017-09-18 13:48:23 +00:00
|
|
|
</div>
|
2016-01-08 01:35:15 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="row">
|
2017-09-18 13:48:23 +00:00
|
|
|
<div class="card-deck">
|
|
|
|
|
<div class="mb-4 card doc-card">
|
|
|
|
|
<div class="mt-4 d-flex justify-content-center section-media">
|
|
|
|
|
<span class="fa-layers fa-fw">
|
|
|
|
|
<i class="fal fa-circle section-icon"></i>
|
|
|
|
|
<i class="far fa-code section-icon" data-fa-transform="shrink-8"></i>
|
|
|
|
|
</span>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="card-body text-center">
|
|
|
|
|
<h4 class="card-title">API Documentation</h4>
|
2018-09-23 22:02:03 +00:00
|
|
|
<p class="card-text">Methods, endpoints, and examples that show how to automate Gophish
|
|
|
|
|
campaigns</p>
|
2017-09-18 13:48:23 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="card-footer d-flex justify-content-center">
|
2018-09-23 22:02:03 +00:00
|
|
|
<a target="_blank" class="btn-feature btn" href="https://docs.getgophish.com/api-documentation/">Read</a>
|
2017-09-18 13:48:23 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="mb-4 card doc-card">
|
|
|
|
|
<div class="mt-4 d-flex justify-content-center section-media">
|
|
|
|
|
<span class="fa-layers fa-fw">
|
|
|
|
|
<i class="fal fa-circle section-icon"></i>
|
|
|
|
|
<i class="fab fa-python section-icon" data-fa-transform="shrink-8"></i>
|
|
|
|
|
</span>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="card-body text-center">
|
|
|
|
|
<h4 class="card-title">Python Client Documentation</h4>
|
|
|
|
|
<p class="card-text">Learn how to use the Python client to automate Gophish campaigns</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="card-footer d-flex justify-content-center">
|
2018-09-23 22:02:03 +00:00
|
|
|
<a target="_blank" class="btn-feature btn" href="https://docs.getgophish.com/python-api-client/">Read</a>
|
2017-09-18 13:48:23 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="mb-4 card doc-card">
|
|
|
|
|
<div class="mt-4 d-flex justify-content-center section-media">
|
|
|
|
|
<i class="fab fa-github section-icon"></i>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="card-body text-center">
|
|
|
|
|
<h4 class="card-title">Developer Documentation</h4>
|
|
|
|
|
<p class="card-text">Full documentation on the Gophish source code</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="card-footer d-flex justify-content-center">
|
|
|
|
|
<a target="_blank" class="btn-feature btn" href="https://godoc.org/github.com/gophish/gophish">Read</a>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2016-01-08 01:35:15 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2017-09-18 13:48:23 +00:00
|
|
|
<div class="jumbotron jumbotron-fluid jumbotron-footer bg-purple">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<div class="row align-items-center">
|
|
|
|
|
<div class="col-xs-12 col-lg-5">
|
|
|
|
|
<h5 class="heading">
|
|
|
|
|
Test Your Exposure to Phishing.
|
2017-10-22 13:55:09 +00:00
|
|
|
<div>
|
|
|
|
|
<br>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<b>For Free.</b>
|
|
|
|
|
</div>
|
2017-09-18 13:48:23 +00:00
|
|
|
</h5>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-xs-12 col-lg-7">
|
|
|
|
|
<div class="d-flex justify-content-lg-end">
|
|
|
|
|
<a class="btn mt-3 mt-lg-0 btn-lg btn-primary" href="https://github.com/gophish/gophish/releases">
|
|
|
|
|
Download
|
|
|
|
|
</a>
|
|
|
|
|
<a class="btn ml-3 mt-3 mt-lg-0 btn-lg btn-primary-o" href="https://github.com/gophish/gophish">
|
2017-10-22 13:55:09 +00:00
|
|
|
<i class="fab fa-github"></i> See the Code
|
2017-09-18 13:48:23 +00:00
|
|
|
</a>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2016-01-08 01:35:15 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2017-09-18 13:48:23 +00:00
|
|
|
<footer class="footer bg-purple">
|
2016-01-08 01:35:15 +00:00
|
|
|
<div class="container">
|
2017-09-18 13:48:23 +00:00
|
|
|
<div class="row">
|
|
|
|
|
<div class="col align-self-center">
|
|
|
|
|
<a class="navbar-brand" href="#">
|
2017-10-22 13:55:09 +00:00
|
|
|
<img src="/img/logo.min.svg" width="30" height="30" class="d-inline-block align-top" alt="" />
|
2017-09-18 13:48:23 +00:00
|
|
|
<strong>Gophish</strong>
|
|
|
|
|
</a>
|
|
|
|
|
<p class="small text-muted">© 2012-2017 Jordan Wright. All rights reserved.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col align-self-center">
|
|
|
|
|
<ul class="nav justify-content-end text-muted">
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a class="nav-link" href="/">Home</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a class="nav-link active" href="/documentation">Documentation</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a target="_blank" class="nav-link" href="https://github.com/gophish/gophish/issues">Support</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="nav-item">
|
|
|
|
|
<a class="nav-link" href="/blog">Blog</a>
|
|
|
|
|
</li>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2016-01-08 01:35:15 +00:00
|
|
|
</div>
|
2017-09-18 13:48:23 +00:00
|
|
|
</div>
|
|
|
|
|
</footer>
|
2016-01-08 05:04:28 +00:00
|
|
|
<script>
|
2017-09-18 13:48:23 +00:00
|
|
|
(function (i, s, o, g, r, a, m) {
|
|
|
|
|
i['GoogleAnalyticsObject'] = r;
|
|
|
|
|
i[r] = i[r] || function () {
|
|
|
|
|
(i[r].q = i[r].q || []).push(arguments)
|
|
|
|
|
}, i[r].l = 1 * new Date();
|
|
|
|
|
a = s.createElement(o),
|
|
|
|
|
m = s.getElementsByTagName(o)[0];
|
|
|
|
|
a.async = 1;
|
|
|
|
|
a.src = g;
|
|
|
|
|
m.parentNode.insertBefore(a, m)
|
|
|
|
|
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
|
|
|
|
|
|
|
|
|
|
ga('create', 'UA-47018345-1', 'auto');
|
|
|
|
|
ga('send', 'pageview');
|
2016-01-08 05:04:28 +00:00
|
|
|
</script>
|
2016-01-08 01:35:15 +00:00
|
|
|
</body>
|
|
|
|
|
|
2017-09-18 13:48:23 +00:00
|
|
|
</html>
|
