django-trawler / README

.. -*- restructuredtext -*-

django-trawler
==============

Trawler is a django app designed to help audit a group of people or organization
in terms of **phishing** awareness.

When used as directed, you can launch your own *phaux-phishing* campaign and track
the members of your organization that actually *follow the link* or load the 
images (either by default or by choice depending on how their mail client is 
configured).

This software was largely inspired by a presentation given by 
`Lance Spitzner <http://www.securingthehuman.org/>`_
in which he described his approach to phishing awareness.

For more detail: http://django-trawler.readthedocs.org/

Installation
------------
If you're familiar with django apps, this process will be familiar.
Install using your choice of ``pip`` or ``easy_install``: ::
    
    $ pip install django-trawler
    
    or ...
    
    $ easy_install django-trawler


Configuration
-------------

In your project settings module:

* Add ``trawler`` and ``django.contrib.admin``  to ``INSTALLED_APPS``.
* Ensure your mail settings are appropriate (the app needs to send mail).
* Ensure you set the domain for your server (django ``Sites`` framework) so
  admin links point to the right place.
* Include ``trawler.urls`` in your urlconf.
* **MAKE ABSOLUTELY SURE** ``DEBUG = False`` before launching a campaign (or your
  *targets* will see nice django 404 pages).
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.