Cleanfeed - Installation and Upgrading

If you're upgrading an existing Cleanfeed installation, please skip to to the Upgrading Instructions.

First Time Installation

Download Cleanfeed from github to the homedir of the news account. If you're using the INN defaults, it will be /usr/local/news. This location is only a recommendation, you can put cleanfeed in any directory providing it's accessible by the news account. The repository contains the following files:

cleanfeed/cleanfeed

cleanfeed/etc/

cleanfeed/etc/bad_adult_paths

cleanfeed/etc/bad_body

cleanfeed/etc/bad_cancel_paths

cleanfeed/etc/bad_groups

cleanfeed/etc/bad_hosts

cleanfeed/etc/bad_paths

cleanfeed/etc/cleanfeed.local

cleanfeed/logs/

Move the cleanfeed file to INN's filter directory. The location of this is defined in inn.conf, (look for the pathfilter option). By default this is /usr/local/news/bin/filter. Rename the cleanfeed file to filter_innd.pl. This will overwrite the example filter file supplied with INN so you might want to take a copy of it first.

cd /usr/local/news/bin/filter

mv filter_innd.pl filter_innd.pl.old

mv /usr/local/news/cleanfeed/cleanfeed filter_innd.pl
Open the filter_innd.pl file with your preferred text editor and check the $config_dir variable is pointing to the correct location of the cleanfeed.local file. If it isn't, correct it and resave the file.
Validate the syntax of cleanfeed and cleanfeed.local:

perl -wc /usr/local/news/bin/filter/filter_innd.pl

perl -wc /usr/local/news/cleanfeed/etc/cleanfeed.local

Note, this check should be done after every Cleanfeed change, prior to reloading the filters. Failure to do so will eventually result in a minor error and INN subsequently dropping all your filters.
Finally, instruct INN to reload its Perl filters:

ctlinnd reload filter.perl meow

Replace 'meow' with a reason for the reload if you want the resulting log messages to be more informative. Check the INN logs to make sure the reload didn't result in any errors. If not, congratulations! Cleanfeed is now running and it's time to look at some customisation.

Upgrading an Existing Installation

If you already have Cleanfeed installed and running, it's likely that you won't want to download the entire tarball as extracting it will overwrite all the files, including those you may have customised.

Download the individual cleanfeed Perl file from github to the binfilter directory.
Rename it to filter_innd.pl (Backup the old filter_innd.pl first if you want to retain it).
Do a syntax check (perl -wc filter_innd.pl)
Reload the filter (ctlinnd reload filter.perl reason).
Check the INN logfiles for any errors

That's it, the new version should be installed and running.