Changes between Version 1 and Version 2 of SpamZilla/CampaignSetupGuide

Show
Ignore:
Timestamp:
02/17/06 09:38:26 (5 years ago)
Author:
scottmc
Comment:

Pretty much complete documentation.

Legend:

Unmodified
Added
Removed
Modified
  • SpamZilla/CampaignSetupGuide

    v1 v2  
    55== Setting up spamzilla == 
    66 
    7 First, you must configure the controller, if you already have a controller installed, you can [wiki:SpamZilla/CampaignSetupGuide#InstallingJavaMail skip this step]. 
     7First, you must configure the controller, if you already have a controller installed, you can [wiki:SpamZilla/CampaignSetupGuide#Startingthecontroller skip this step]. 
    88 
    99Install perl 5.8.0 or newer on your controller machine, and postgresql.  You will also need the following list of Perl Modules available from CPAN: 
     
    3131A custom version of {{{POE::Component::Client::SMTP}}} is included in the distribution. 
    3232 
    33 Once this is done you must configure spamzilla.  I will not go over the configuration details here, they are quite simple.  An example configuration file is attached. 
     33Once this is done you must configure spamzilla.  I will not go over the configuration details here, they are quite simple, and documented in the [wiki:SpamZilla/Configuration configuration reference].  An example configuration file is attached. 
     34 
     35''See also'' SpamZilla/Configuration 
    3436 
    3537== Starting the controller == 
     38If the controller is already running (you can reach the mozilla web interface) then you can [wiki:SpamZilla/CampaignSetupGuide#InstallingJavaMail skip this step]. 
    3639 
    3740The controller has several command line options 
     
    5457== Installing JavaMail == 
    5558 
    56 The Spamzilla Java Mail component requires the following libraries, they should be included, but if any of them seem to be missing: 
     59If the mailer is already installed on all systems you wish to use, you can [wiki:SpamZilla/CampaignSetupGuide#StartingJavaMail skip this step]. The Spamzilla Java Mail component requires the following libraries, they should be included, but if any of them seem to be missing: 
    5760 
    5861{{{ 
     
    9295{{{ 
    9396tcsh> setenv JAVA_HOME /opt/jdk1.5 
    94 bash$ exoprt JAVA_HOME=/opt/jdk1.5 
     97bash$ export JAVA_HOME=/opt/jdk1.5 
    9598}}} 
    9699 
     
    117120}}} 
    118121 
    119 The JavaMail node should now be running.  Now you can build and send a campaign. 
     122The JavaMail node should now be running.  Now you can build and send a campaigns. 
     123 
     124== Building a Campaign == 
     125 
     126 1. Go to the SpamZilla Controller Interface. 
     127 2. First, import your list. 
     128 3. Click "Import" in the top menu, and then "Target List". 
     129 4. Now select your list 
     130 5. Press Ok. 
     131 
     132Wait patiently for the import to complete.  You should get a popup notification giving you statistics of the import.  The larger the list is, the longer it takes to import.  The import process is rather complicated, the server will open a port for the client to connect to and dump the file you selected, once that is done, the server will parse the header of the CSV file, then load the list into the database. once this is done, the server will proceed to resolve the MX records, and MX domains, of each email domain in the list. 
     133 
     134''Example CSV'' 
     135{{{ 
     136"Email","Firstname","Lastname" 
     137"tag@cpan.org","Scott","McCoy" 
     138"tag@blisted.org","Scott","McCoy" 
     139}}} 
     140 
     141Once you have finished that you may import a template.  The template import expects a zip file, filled with atleast 1 html template and possibly one or more text templates of other types.  All text templates will be parsed at the time of send, and all non-text files will be attached, MIME Encoded as is.  If you wish to link to the attached files from the HTML template, you may refer to the files as cid:<name of file in archive, including possible path>. 
     142 
     143You may use the following style of template tokens !{{{Token}}}, with the corresponding name of the database field or one or more special fields, such as {{{Key, TargetID, CampaignID}}}.  Key's are case insensitive. 
     144 
     145''If you're planning on logging clicks or opens you will want to use the !{{{Key}}} token as the first directory of your link.'' 
     146 
     147== Setting up a tracking server == 
     148 
     149At this point you may want to set up a tracking server.  To set up a tracking server, follow the instruction for setting up a controller.  But you will likely want to configure the controller to be only a webserver. 
     150 
     151''Figure: Example webserver-only controller configuration'' 
     152{{{ 
     153<spamzilla xmlns="http://www.blisted.org/spamzilla/config"> 
     154    <daemon type="perl" 
     155        daemonize="true" 
     156        user="www-data 
     157        group="www-data" 
     158        pid="/tmp/spamzilla.pid" /> 
     159 
     160    <database  type="DBI" 
     161               dsn="DBI:Pg:dbname=spamzilla;host=204.15.164.12" 
     162               username="root"/> 
     163    <webserver type="POE" 
     164               address="<IP HOSTING DOMAIN>" 
     165               port="80" 
     166               authenticate="false" 
     167               track="true" 
     168               indexfile="spamzilla.xul" 
     169               docroot="/path/to/document/root"> 
     170        <servlet uri="/optout.html" type="POE" name="Optout"> 
     171    </webserver> 
     172</spamzilla> 
     173}}} 
     174 
     175Then, place any images or links you wish to use for tracking in the document root of the web service.  To track email opens, you will need to place the tracking image in the subdirectory "open".  You may link to it as http://yourdomain.com/!{{{Key}}}/open/pixel.png, for example.  Placing this in an {{{img}}} tag in your template will create a tracking secenario. 
     176 
     177Any redirections you wish to do will need to be manually set up.  You can use a meta-redirect or a frame forward, whichever is your preference.  Stick a redirection page for your sponsor in the document root of your webserver. 
     178 
     179''Figure: refresh.html, Example Redirect Page'' 
     180{{{ 
     181<html> 
     182   <head> 
     183      <meta http-equiv="refresh" content="1;http://your/sponsor/url"/> 
     184   </head> 
     185   <body> 
     186   </body> 
     187</html> 
     188}}} 
     189 
     190Link to the page using the a url signature such as http://yourdomain.com/!{{{Key}}}/refresh.html.  This will track users as they open and click on your emails links. 
     191 
     192== Building a campaign == 
     193 
     194To build a campaign, go back to the controllers web interface.  Click on {{{New > Campaign}}}.  The campaign wizard will start up.  Follow the steps of the campaign wizard, they are relatively simple.  First select a list, then targets to email from.  I suggest that you set up your mailing servers IPs as MX handlers for the domains you are sending email as, for SPF compliance.  Then insert your subjects, select your templates, and select a time to schedule the campaign for sending. 
     195 
     196If all is well, your mail will start sending on time, your message views and clicks will get tracked.