1. Owen Nelson
  2. django-trawler


Owen Nelson  committed 35ee96a

updating docs for the current state of the app (refs #8)

  • Participants
  • Parent commits 47fab5c
  • Branches default

Comments (0)

Files changed (1)

File docs/user_guide.rst

View file
 User Guide
 What is this for?
 How does it work?
 In order to run a successful campaign we need to compose an email with at least 
 one way of *pinging* back to our application embedded in it.
 Pinging our application is handled by making a HTTP request, either through the 
 click of a link, or the requesting of an img src. The actual urls are
 dependent on how your application is deployed, but given trawler is 
-running on ``http://localhost:8000/trawler/`` (a local dev server with the app 
-itself having a ``trawler`` prefix), here are the 2 methods available:
+running on ``http://localhost:8000``:
-#. link url: ``http://localhost:8000/trawler/l/%(upk)d/``
-#. image url: ``http://localhost:8000/trawler/i/%(upk)d/``
+#. link url: ``http://localhost:8000{{ target.link_uri }}``
+#. image url: ``http://localhost:8000{{ target.img_uri }}``
 The above urls can be followed by any valid url parts, for example we can write
+``http://localhost:8000{{ target.img_uri }}awesome/cgi-bin/application.pl`` 
 and it would be the same as writing
+``http://localhost:8000{{ target.link_uri }}forum/index.php``
 Each of these urls types (image and link) behave slightly differently on the 
 application end. When a user clicks on the *link*, in the email, we record a 
 client, otherwise it returns an ``HTTP 404`` status (thus displaying a "broken" 
-.. note:: The ``%(upk)d`` in the urls should be entered literally. Trawler will 
+.. note:: The **{{ target.link_uri }}** and **{{ target.img_uri }}** in the urls should be entered literally. Trawler will 
           substitute the token for the ID of each target in the campaign prior 
           to sending out the mail.
 After I've saved this campaigned (with myself as a target), I return to the 
 campaign list page, **check the box next to my campaign** to select it, then 
-choose **launch** from the dropdown menu above, finally clicking the **go** 
-button to actually send out the mail.
+choose **test** or  **launch** from the dropdown menu above, finally clicking
+the **go** button to actually send out the mail.
-.. note:: There's a *test* action available as an alternative to the **launch**
-          action, but it's kind of ghetto right now. It will send the mail to 
-          the currently logged in user, but leave ``%(upk)d`` value as ``-1``. What 
-          this means is you can check the link structures and other markup, but 
-          the image will never load (if applicable).
+Here's the rundown on what these 2 actions do:
+    Send the campaign email to all targets associated with the campaign.
+    There is no confirmation for this. Furthermore, there are no take-backs.
+    Do not launch until you are sure everything is in order.
+    Sends the email to **you** (the current logged in user), but does not 
+    register links and images viewed as normal. Use this to verify your links
+    are correct (or to see how your spam filter reacts to the message).
 Monitoring the Campaign
 Visiting the campaign edit page, you'll see a button on the top right labeled 
 *view on site*. Follow that link and you'll see the *campaign results* page, 
 which for me looks a bit like this:
 .. [#phishers] Not sure if this is actually a word. Read: *people that run 
    phishing scams*.
 .. [#suspicious] The level of suspiciousness is entirely up to you.
-.. [#rickroll] See: http://en.wikipedia.org/wiki/Rickrolling
+.. [#rickroll] See: http://en.wikipedia.org/wiki/Rickrolling