Baruwa Documentation Release 1.1.2
Total Page:16
File Type:pdf, Size:1020Kb
Baruwa Documentation Release 1.1.2 Andrew Colin Kissa June 27, 2016 Contents 1 Introduction 3 2 Features 5 3 Screenshots 7 4 Requirements 9 4.1 Baruwa requirements.........................................9 4.2 MailScanner requirements......................................9 5 Source Installation 11 5.1 Install Baruwa............................................ 11 5.2 Configure RabbitMQ......................................... 12 5.3 Configure Baruwa.......................................... 12 5.4 Configure MailScanner........................................ 14 5.5 Testing................................................ 15 5.6 Need help............................................... 16 5.7 Distribution / OS installation..................................... 16 6 Baruwa on RHEL/SL/Centos 17 6.1 Install EPEL............................................. 17 6.2 Baruwa installation.......................................... 17 6.3 Configure RabbitMQ......................................... 17 6.4 Configure Baruwa.......................................... 18 6.5 Configure MailScanner........................................ 19 6.6 Testing................................................ 20 6.7 Need help............................................... 20 7 Baruwa on Fedora 21 7.1 Baruwa Installation.......................................... 21 7.2 Configure RabbitMQ......................................... 21 7.3 Configure Baruwa.......................................... 22 7.4 Configure MailScanner........................................ 23 7.5 Testing................................................ 24 7.6 Need help............................................... 24 8 Baruwa on Ubuntu/Debian 25 8.1 Install & Configure RabbitMQ.................................... 25 8.2 Configure RabbitMQ......................................... 25 8.3 Baruwa Apt install.......................................... 25 8.4 Automated configuration....................................... 26 8.5 Configure MailScanner........................................ 26 8.6 Configure Baruwa.......................................... 27 i 8.7 Testing................................................ 27 8.8 Need help............................................... 28 9 External authentication 29 9.1 SMTP, POP3, IMAP and RADIUS/RSA SECURID........................ 29 9.2 ACTIVE DIRECTORY....................................... 29 9.3 LDAP................................................. 30 10 MTA Integration 31 10.1 Postfix................................................ 31 10.2 Exim................................................. 32 11 Clustered setups 33 12 Other batteries included 35 12.1 Command options and help..................................... 35 12.2 Quarantine management....................................... 35 12.3 Quarantine reports.......................................... 35 12.4 Database maintenance........................................ 35 12.5 Spamassassin rule description updates................................ 35 12.6 PDF reports.............................................. 36 12.7 Mailq Stats updates.......................................... 36 12.8 Email Signatures configuration................................... 36 13 Getting Help 37 13.1 How do I do X? Why doesn’t Y work? Where can I go to get help?................ 37 13.2 I think I’ve found a security problem! What should I do?...................... 37 13.3 Can i get Commercial Support or pay for an installation...................... 37 14 Contributing to Baruwa 39 14.1 Reporting bugs............................................ 39 14.2 Submitting patches.......................................... 39 14.3 Documentation............................................ 39 14.4 Donations............................................... 39 14.5 Translation.............................................. 40 15 Upgrading 41 15.1 1.1.2................................................. 41 15.2 1.1.1................................................. 41 15.3 1.1.0................................................. 42 15.4 1.0.2................................................. 42 15.5 1.0.1................................................. 42 16 Migrate from Mailwatch 43 16.1 User contributed tips......................................... 43 17 User Guide 45 17.1 Interface primer........................................... 45 17.2 FAQ’s................................................. 47 18 Older documentation 49 ii Baruwa Documentation, Release 1.1.2 Release 1.1.2 Build Date June 27, 2016 Baruwa (swahili for letter or mail) is a web 2.0 MailScanner front-end. It provides an easy to use interface for managing a MailScanner installation. It is used to perform operations such as releasing quarantined messages, bayesian learning, whitelisting and blacklisting addresses, monitoring the health of the services etc. Baruwa is implemented using web 2.0 features (AJAX) where deemed fit, graphing is also implemented on the client side using SVG, Silverlight or VML. Baruwa has full support for i18n, letting you support any language of your choosing. It includes reporting functionality with an easy to use query builder, results can be displayed as message lists or graphed as colorful and pretty interactive graphs. Custom MailScanner modules are provided to allow for logging of messages to the mysql database with SQLite as backup, managing whitelists and blacklists and managing per user spam check settings. Baruwa is open source software, written in Python/Perl using the Django Framework and MySQL or PostgreSQL for storage, it is released under the GPLv2 and is available for free download. Contents 1 Baruwa Documentation, Release 1.1.2 2 Contents CHAPTER 1 Introduction Baruwa (swahili for letter or mail) is a web 2.0 MailScanner front-end. It provides an easy to use interface for managing a MailScanner installation. It is used to perform operations such as releasing quarantined messages, bayesian learning, whitelisting and blacklisting addresses, monitoring the health of the services etc. Baruwa is implemented using web 2.0 features (AJAX) where deemed fit, graphing is also implemented on the client side using SVG, Silverlight or VML. Baruwa has full support for i18n, letting you support any language of your choosing. It includes reporting functionality with an easy to use query builder, results can be displayed as message lists or graphed as colorful and pretty interactive graphs. Custom MailScanner modules are provided to allow for logging of messages to the mysql database with SQLite as backup, managing whitelists and blacklists and managing per user spam check settings. Baruwa is open source software, written in Python/Perl using the Django Framework and MySQL or PostgreSQL for storage, it is released under the GPLv2 and is available for free download. 3 Baruwa Documentation, Release 1.1.2 4 Chapter 1. Introduction CHAPTER 2 Features • AJAX support for most operations • Reporting with AJAX enabled query builder • I18n support, allows use of multiple languages • Signature management / Branding • Mail queue management and reporting • Interactive SVG graphs • Emailed PDF reports • Archiving of old message logs • SQLite backup prevents data loss when MySQL or PostgreSQL is down • MTA integration for relay domains and transports configuration • Multi user profiles (No restrictions on username format) • User profile aware white/blacklist management • Ip / network addresses supported in white/blacklist manager • Easy plug-in authentication to external authentication systems (POP3, IMAP, SMTP, Active Directory and RADIUS supported out of the box) • Tools for housekeeping tasks (quarantine management, rule updates, quarantine notifications, etc) • Easy clustering of multiple servers • Works both with and without Javascript enabled (graphs require Javascript) 5 Baruwa Documentation, Release 1.1.2 6 Chapter 2. Features CHAPTER 3 Screenshots Screenshots are on our site. 7 Baruwa Documentation, Release 1.1.2 8 Chapter 3. Screenshots CHAPTER 4 Requirements 4.1 Baruwa requirements • Python >= 2.4 • Django >= 1.2 • django-celery • django-south • MySQL-Python >= 1.2.1p2 or Psycopg • GeoIP-Python • iPy • Any Web server that can run Django (Apache/mod_wsgi recommended) • A supported Message broker (RabbitMQ recommended) • MySQL or PostgreSQL • Dojo toolkit >= 1.5.0 • Reportlab • Lxml • Anyjson • UUID (Only for python 2.4) • Sphinx (Optional - to build documentation) • Pyrad (Optional for RADIUS/RSA SECURID authentication) • Python ldap (optional for Active directory authentication) 4.2 MailScanner requirements • MailScanner >= 4.80.10-1 • DBI • DBD-MySQL or DBD-Pg • DBD-SQLite 9 Baruwa Documentation, Release 1.1.2 10 Chapter 4. Requirements CHAPTER 5 Source Installation Note: Packages are available for Debian/Ubuntu, RHEL/SL/Centos and Fedora if you are using one of those OS’s rather install using the packages. If you do not want to install to your global python directories or are just testing it is advised that you use a virtualenv python install. Virtualenv allows you to run multiple python installs and is easily managed as you do not need to be a privileged user to install packages. For more info on virtualenv please refer to its documentation. 5.1 Install Baruwa You can install Baruwa either via the Python Package Index (PyPI) or from source. 5.1.1 Install via the Python Package Index (PyPI) To install using pip: # pip install baruwa < 2.0.0 To install using easy_install: # easy_install baruwa < 2.0.0 5.1.2 Downloading and installing from source Download the latest version