Documentation/Hawkeye

Bongo project has created many ways to manage users, domains and features, one of them is the Hawkeye Web Adminstration Interface.

Here will be explained every option of this interface, the main purporse is to be used as cross-reference when needed.

In this documentation we will use localhost, as domain name, you have to change it to fit your needs, the nice thing is, if you're accessing this document from same computer where Bongos is installed, you will be directed to the right page (thanks to REST architecture).

Contents 1 About the interface 2 Login screen 3 Desktop 4 Users 5 Agents 5.1 Enable/Disable 5.2 SMTP 5.3 IMAP 5.4 Antivirus 5.5 POP3 5.6 Global 5.7 Mail Proxy 5.8 Queue 5.9 Antispam 6 System 6.1 Backup and Restore 6.2 Domain 6.2.1 Creating a new domain 6.2.2 Removing a domain 6.2.3 Editing a domain 7 Help

About the interface

The admin interface is made to be simple, clean and objective. It requires a "modern" web browser to work, because it was made with XHTML. Every page fits very well on screen, even in small displays (800x600), they are divided in 3 main sections.

1. Header
2. Body
3. Footer

On header you will find the Bongo logo on left side, and username on right side (with a logout button right aside), on footer there is the tool version and the GPL disclaimer), our main focus lies on body where we will find all options.

The body section is divided in two section the left one is the sidebar, where you can browse every subject (better explained later), on right side you will find the sub-sections from every subject choosen previously, if you select any sub-section, you will be taken to Bongo configuration options. You can also toogle the sidebar on/off clicking on label Toggle sidebar.

Login screen

This screen is very straight forward, we have just 3 objects, they are:

• Username - A valid username with administrative privileges (see Creating Users).
• Password - The username password.
• Language - Chooses the interface language.

Desktop

The desktop window is the first window seen after login, it shows some information about Bongo itself and the system where it is installed.

• Agent Status
• Bongo Updates
• System status
• Memory usage
• Load
• Last 5 actions

Users

Not available on M3

Agents

An agent is a subsystem responsible for a very specific task inside Bongo. In agents tab set, you will find handlers to manage every Bongo agent, there are 12 available agents. They are:

• bongoqueue - controls the Bongo mail queue
• bongosmtp - receives e-mail via SMTP protocol
• bongosmtpc - sends e-mail smtpc via SMTP protocol (the C stands for client)
• bongoantispam - runs antispam in every message processed by smtp agent
• bongoavirus - runs antivirus in every message processed by smtp agent
• bongocollector -
• bongomailprox -
• bongopluspack -
• bongorules -
• bongoimap - allow users access bongo store via IMAP protocol
• bongopop3 - allow users access bongo store via POP3 protocol
• bongostandalone -

Enable/Disable

This page allows you to enable and disable specific agents during runtime for change at next restart.

Please note that you must restart bongo-manager for these changes to take effect, since they're only to do with the agent list at startup, not dynamic starting and stopping.

SMTP

This page allows you to manage how smtp and smtpc agents will behave. The options are:

Parameter	Default value	Valid input	Description
SSL Port	465	1-65535	The TCP port where "bongosmtp" will listen for incoming secure connections.
Socket timeout	600	numeric	Value in seconds to wait in an idle connection
Port	25	1-65535	The TCP port where "bongosmtp" will listen for incoming connections (do not change, unless you really know what you're doing)
Maximum recipients	15	numeric	Max number of recipients per message, if number exceeds, the message will be dropped without any explanation
Message size limit	0	numeric	Maximum value in bytes allowed in a single message (0 for no limit)
Allow client SSL	False	Bool	Enable/Disable support to SSL clients
Maximum MX servers	20	numeric	?
Maximum threads	10000	numeric	Maximum number of threads spawned for bongosmtp/smtpc agents.

IMAP

This page allows every configuration related with bongoimap handler.

Parameter	Default value	Valid input	Description
Port	143	1-65535	The TCP port where "bongoimap" will listen for incoming connections (do not change, unless you really know what you're doing)
SSL Port	993	1-65535	The TCP port where "bongoimap" will listen for incoming secure connections.
Maximum threads	50	numeric	Maximum number of threads spawned for bongoimap agents.

Antivirus

This page allows you to manage how agent bongoavirus will handle anti virus checks, right now only ClamAV is supported. The antivirus configuration is beyond of scope of this document, and it's covered on Administration Guide

Parameter	Default value	Valid input	Description
Timeout	15	numeric	Maximum time (in milliseconds) to connect to antivirus server.
Hosts	127.0.0.1:3310:1	HOST:PORT:?	Colection of hosts:port (one per line), where antivirus servers are configured

POP3

This page allows every configuration related with bongopop3 handler.

Parameter	Default value	Valid input	Description
Port	110	1-65535	The TCP port where "bongopop3" will listen for incoming connections (do not change, unless you really know what you're doing)
SSL Port	995	1-65535	The TCP port where "bongopop" will listen for incoming secure connections.

Global

skel

Mail Proxy

skel

Queue

skel

Antispam

skel

System

skel

Backup and Restore

skel

Domain

skel

Creating a new domain

skel

Removing a domain

skel

Editing a domain

skel

Help

Not available in M3