This procedure shows you how to install POPfile on Mac OS X 10.4.x systems, and how to create a startup item that will start POPfile each time you reboot the system.

As of Mac OS X 10.4, Mac OS X comes with Perl and SQLite3 installed. So you'll simply need to install Xcode, a few Perl library packages, and a startup item.

Note: Because setting up CPAN, a Perl package manager, or Fink, another package manager, on a virgin system can complicate matters, we'll stick with the source and do it the old-school way to avoid complications.

1. Install Xcode from the CD/DVD that came with your Mac. You may also download it from here:

Apple Xcode Web Page

2. Download the cross-platform version of POPFile from here:

Cross-Platform POPfile

3. Download these Perl library packages (from the CPAN Web Site) and place them all into a folder on your desktop named “packages”:

• Date::Parse — part of TimeDate
• Date::Format — also part of TimeDate
• HTML::Tagset — HTML-Tagset-3.10
• DBI — DBI-1.53
• DBD::SQLite2 — DBD-SQLite2-0.33
• MIME::Base64 — MIME-Base64-3.07
• HTML::Template — HTML-Template-2.8
• HTML::Tagset — HTML-Tagset-3.10

4. Install each of the Perl library packages you downloaded in the previous step:

• a. Open a terminal window if one is not already open.

• b. Enter the command to change the working directory to the “packages” folder on your desktop:

<nowiki>cd ~/Desktop/packages</nowiki>

• TIP: ~ means “your home directory”. So ~/Desktop/packages means /Users/yourusername/Desktop/packages.

• c. Enter the command to expand the package (where name is the name of the package):

tar xzvf //name//<nowiki>.tar.gz</nowiki>

• d. Enter the command to change the working directory to the expanded package folder (where name is the name of the expanded package folder):

cd //name//

• e. Enter the command to build the GCC make file from the Perl make file:

perl <nowiki>MakeFile.PL</nowiki>

• f. Enter the command to compile the project:

make

• Note: If you compile any of these packages and it outputs an error starting out with something like: Can't locate DBD/SQLite2.pm in @INC, that means that package depends on other Perl library packages. The dependency package name is right after the word “locate” (in this example, it is DBD::SQLite2).

• g. Enter the command to install the library package into your system:

sudo make install

5. Enter the command to create a folder to hold POPfile (we suggest ~/Library/POPfile):

mkdir <nowiki>~/Library/POPfile</nowiki>

TIP: ~ means “your home directory”. So ~/Library/POPfile means /Users/yourusername/Library/POPfile.

Note: While this folder can reside anywhere, we suggest you create it somewhere in your home directory so that if you back up your home directory, POPfile gets backed up as well. We assume you have used the location ~/Library/POPfile for the rest of this procedure.

6. Copy or move the POPfile ZIP archive into ~/Library/POPfile folder you just created.

7. Expand the POPfile ZIP archive archive in the ~/Library/POPfile folder. You should now have a bunch of files in ~/Library/POPfile - one of which is popfile.pl.

Note: If the POPfile ZIP archive expands into a sub-folder in ~/Library/POPfile, move all items into ~/Library/POPfile and get rid of the sub-folder.

8. Test your POPfile installation:

• a. Open a terminal window if one is not already open.

• b. Enter the command to change the working directory to the ~/Library/POPfile folder:

cd <nowiki>~/Library/POPfile</nowiki>

• c. Enter the command to start POPfile manually:

perl popfile.pl

• d. Watch the output in the terminal. If POPfile is installed properly, you should not see any errors.

• Note: If you start POPfile and it outputs an error starting out with something like: Can't locate DBD/SQLite2.pm in @INC, that means you still need to install one or more Perl library packages. The package name is right after the word “locate” (in this example, the Perl library package you need to install is DBD::SQLite2).

• Note: At this point POPfile is installed properly, but will not start up automatically every time you reboot.

• e. Type Control-C into the terminal window to stop POPfile and exit to the command prompt.

9. Create the Mac OS X POPfile startup item:

• a. Enter this command to create the folder /Library/StartupItems/POPfile:

sudo mkdir -p <nowiki>/Library/StartupItems/POPfile</nowiki>

*b. Create a plain text file named "<nowiki>StartupParameters.plist</nowiki>" in the <nowiki>/Library/StartupItems/POPfile</nowiki> folder with this content:

{

Description		= "POPfile mail classification proxy";
Provides		= ("popfile");
Requires		= ("Network");
Uses			= ("Disks", "Network Time", "IPServices");
<nowiki>OrderPreference</nowiki>	= "Last";
Messages =
{
	start = "Starting POPfile";
	stop  = "Stopping POPfile";
};

}

• Note: Use a plain text editor (like the command-line editor,vi, or the GUI editor TextWrangler). Make sure the text file content is plain text.

• c. Create a plain text file named “POPfile” in the /Library/StartupItems/POPfile/ folder with this content:

<nowiki>
#!/bin/sh
#
# POPfile - startup script
#
# For this to work POPfile should be in /Library/POPfile
#
. /etc/rc.common

PFPATH='/Users/</nowiki>//yourusername//<nowiki>/Library/POPfile'

if [ "$1" == "start" ]
then
	pid=$( ps -auxww | grep popfile.pl | grep -v grep | awk '{ print $2 }' )

if ! [ $pid ]; then
	ConsoleMessage "Starting POPfile mail classification proxy"
	cd "$PFPATH"
	perl popfile.pl > /dev/null 2>&1 &
fi

elif [ "$1" == "stop" ]
then

pid=$( ps -auxww | grep popfile.pl | grep -v grep | awk '{ print $2 }' )
if [ $pid ]; then  
	ConsoleMessage "Stopping POPfile mail classification proxy"		
	kill -6 $pid
fi

elif [ "$1" == "restart" ]
then

pid=$( ps -auxww | grep popfile.pl | grep -v grep | awk '{ print $2 }' )
ConsoleMessage "Restarting POPfile mail classification proxy"
kill -HUP $pid
cd "$PFPATH"
perl popfile.pl > /dev/null 2>&1 &

fi
 </nowiki>

• Note: Use a plain text editor (like the command-line editor,vi, or the GUI editor TextWrangler). Make sure the text file content is plain text.

• d. Enter this command to create a folder at /Library/StartupItems/POPfile/Resources:

sudo mkdir <nowiki>/Library/StartupItems/POPfile/Resources</nowiki>

• e. Enter this command to crreate a folder at /Library/StartupItems/POPfile/Resources/English.lproj:

sudo mkdir <nowiki>/Library/StartupItems/POPfile/Resources/English.lproj</nowiki>

• f. Create a plain text file named “Localizable.strings” in the /Library/StartupItems/POPfile/Resources/English.lproj/ folder with this content:

<nowiki>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist SYSTEM " file://localhost/System/Library/DTDs/PropertyList.dtd" ; ;>
<plist version="0.9">
<dict>
<key>Starting POPfile</key>
<string>Starting POPfile </string>
<key>Stopping POPfile </key>
<string>Stopping POPfile </string>
</dict>
</plist>
</nowiki>

• Note: Use a plain text editor (like the command-line editor,vi, or the GUI editor TextWrangler). Make sure the text file content is plain text.

• g. In a terminal window, enter these commands:

cd <nowiki>/Library/StartupItems</nowiki>
sudo chown -R root.admin popfile
cd popfile
sudo chmod 754 popfile
sudo chmod 644 <nowiki>StartupParameters.plist</nowiki>

10. Finally, to start up POPFile without rebooting enter this terminal command:

sudo <nowiki>/Library/StartupItems/POPfile/POPfile start</nowiki>

TO DO: Add details about the relationship between POPfile, DBD::SQlite2, and the SQLite3 command-line tool included with Mac OS X 10.4.x.

TO DO: Add instructions to edit the popfile.cfg file and change the bayes_dbconnect property to dbi:SQLite2:dbname=$dbname to speed up POPfile launch times.