* * * INSTRUCTIONS * * *
Installation of P.O.E. 0.1.6
No Longer In Development
Use At Your Own Risk
There are probably bugs in this software:
Check here for known bugs.
Licensed under the GNU General Public License, v.2
ABSOTIVELY, POSIXLUTELY NO WARRANTY OF ANY KIND
Read Instructions Completely Before Doing Anything
This Means You
- - - - - - - - - - - - - - - - - -
View this page unframed
Here's how to install P.O.E. 0.1.6
- Set up a test email account if you don't have one
already. Do Not run P.O.E. on a real email account until you're sure
everything is OK.
- Untar the P.O.E. tarball in your home directory. You'll move some of the
subdirectories to your home directory later.
- As root, in the P.O.E. subdirectory, do "chown -r
yourname:yourname *" where yourname is your non-root username.
- Install daemontools. You'll use svc to run getmail periodically. Now,
- install qmail. ( That should keep you busy awhile :-) Once
- install checkpassword,
- Set up qmail-pop3d, and
- install getmail.
- Replace the ".getmail" directory that gets installed into your home directory
with the one from the P.O.E. directory.
- The .getmail directory should look like this:
- log/main <--- the getmail log dir.
- supervise <--- used by svc to monitor the run scripts.
- run <--- P.O.E. run files.
- getmailrc <--- getmail config file.
- Configure getmailrc to use the test account you previously set up.
- Install safecat.
- In your home directory, create a symlink FROM -Note the Leading
Dot-".getmail" TO "getmail" -with no leading dot. You need this so you
can symlink the getmail directory to /service, which won't work with .directories .with .a .leading .dot.
- I find Midnight Commander mighty handy for this sort of
thing. You're going to be making a few symlinks...
- Now, copy the CRM114 subdirectory from the P.O.E. directory to
your home directory. It's got subdirectories for logging, and to point
to your Mozilla mail directory, etc., and should contain the following
scripts and files:
- adbook.csv - a file needed by adbook.pl; it's overwritten
when exporting the Mozilla whitelist, and by adbook.pl.
- adbook.pl - updates your CRM114 whitelist when you change your
- Edit the adbook.pl script and change the $homedir
and $mozdir values to yours.
- alert.crm - issues alerts on good incoming email not in no_alert.mfp.
- crmfilter.sh - runs CRM114 on your incoming emails.
- Edit the crmfilter.sh script and change the HOMEDIR
value to yours.
- learnfile.sh - learns files as (non)spam and archives them.
- Edit the learnfile.sh script
- Change HOMEDIR and MAILDIR values to yours.
- Set KILLBROWSER to 1 to automatically kill you browser when
learning (non)spam. Otherwise, learning will be postponed until
learnfile.sh detects that your browser isn't running. The browser must
be stopped while learnfile.sh deletes file(s) where learned (non)spam
is stored, then creates new empty ones
- no_alert.mfp - list of good mail you don't want alerts on.
- Edit no_alert.mfp if there are types of mail you
don't want alerts on. e.g. lists. Use email addresses or
- static_whitelist.mfp - whitelist added to final whitelist
along with updated addressbook contents.
- Edit static_whitelist.mfp if there are types of
mail you want whitelisted regardless of what's in your
address book. Use email addresses or words/strings.
- update_whitelist.txt - message emitted by adbook.pl when you
change your Mozilla whitelist.
- whitelist.mfp - WARNING: Do Not edit whitelist.mfp! It
will be automatically overwritten by adbook.pl. Edit
- The CRM114 directory should contain these subdirectories:
- MozMail < --- Symlink you make to your Mozilla maildir.
- temp/tmp <--- Getmail delivers the mail here via safecat.
- temp/new <--- crmfilter.sh picks up the mail here.
- logs/alert <--- alert.crm logs
- logs/auto_whitelist < -- Whitelist updates. Not "auto" yet.
- logs/learnfile <--- learnfile.sh logs
- logs/mailfilter <--- mailfilter.crm logs
- logs/getmail <--- symlink you make to getmail logs.
- Install the latest release of CRM114, and put the files you need
in the CRM114 directory in your home directory.
- In the CRM114 directory, do "chown yourname:yourname *"
- Create a symlink FROM ~/.mozilla/.../Mail/your_maildir TO ~/CRM114/your_maildir
- Create a symlink FROM ~/.getmail/log/main TO ~/CRM114/logs/getmail
- Edit the "run" script in the .getmail directory:
- Edit the polling interval value. I reccommend 180 seconds (3 minutes)
- Add your username and home directory path to the respective variables.
- Change the line that says where to find a sound file to play on alerts.
- You may have to change the sound player line too. Didn't I say this was labrinthine?
- The "Testing Stuff" section:
- If you want to be alerted when getmail is polling, uncomment
the line that says
# $PLAYER $SOUNDFILE_TEST
and edit the SOUNDFILE_TEST variable.
- If you want test emails sent out every polling interval,
uncomment and edit the lines:
# EMAIL_ADDRESS="" # <-- Put yours here
# echo "$DATE" ;echo "Test" | mail -s "Test: $DATE" $EMAIL_ADDRESS
- Edit the "run" script in the ~/.getmail/log directory:
- Replace "gadget" with your username
- Make a symlink FROM ~/getmail --NOT ~/.getmail-- TO
/service. Getmail should begin polling any servers you have listed in
- Once you're pretty sure everything's working, you can begin to
transition to using P.O.E. on a real email account. Here's how I
suggest you proceed:
- Turn off getmail polling: As root:
- # cd /service
- # svc -d getmail
- # svstat getmail
- getmail down N seconds, normally up
- If you don't already have an email account in Mozilla/Netscape, set one up.
- The server address should be to your ISP's mail server. Set the
polling interval to 60 minutes or so to give P.O.E. plenty of chances to get the mail first.
- Make sure this account is set up NOT TO receive mail at startup,
or else it'll pre-empt P.O.E. having a chance to intercept most of
your spam which you probably get each morning when you log in. :-)
- Set this account to download all email, then remove messages from
the server, to prevent unreceived messages from piling up on the
server. This is your failsafe account. You'll always get your mail through this one even if P.O.E. breaks somehow.
- Direct getmail to point at your real email address by editing the
proper lines in ~/.getmail/getmailrc.
- Set the getmail account to read all new messages, but to not
delete them from the server. See the getmailrc in the P.O.E. dist, or
- Set the getmail polling interval to 180 seconds (3 minutes) via
the ~/.getmail/"run" script.
- Set up a second account for P.O.E. to use:
- Set the server address of this one to localhost or
your.server.name. using the name of the box running
- Set the polling inverval for 1 minute.
- Using the browser's mail-window, create folders in your mail
directory labeled "spam", and "nonspam"
- Set up a filter in Mozilla to direct any mail that has "ADV:" in
the subject line to the trash.
- Turn on getmail polling: As root:
- # cd /service
- # svc -u getmail
- # svstat getmail
- getmail: up (PID NNNN) N seconds.
- Relax, and wait for the beep.
* * * END * * *