FlowTraq Documentation
Sidebar Prev | Up | Next

4.3. Email Reporting Configuration

4.3.1. Global Configuration

The report plugin sends an HTML email to specified addresses according to the set schedule. The plugin must be configured with valid credentials for an email server it can connect to; this is a global configuration rather than a report-by-report configuration.

The configuration file used to provide these credentials is called plugin.conf. It is located in each Emailed Report plugin's installation directory, typically:

            /opt/flowtraq/PLUGINS/basic-reports
        

In order to provide these credentials, copy or rename plugin.conf-sample to plugin.conf, and open it for editing. Fill in the necessary details to describe your mail server and successfully authenticate, and save the file. All reports will use these settings.

It is recommended to restrict read permissions for this file:

            chmod 600 plugin.conf
        

Changes to this file take place immediately and do not require a restart of FlowTraq.


Prev Up Next
 Home 
  • Contents
  • Search
loading table of contents...
  • Introduction
    • System Overview
    • Support, Training, and Professional Services
      • Technical Support
      • Training and Professional Services
    • Change Log
      • Changes in FlowTraq 18.2
      • Changes in FlowTraq 17.7
      • Changes in FlowTraq 17.2
      • Changes in FlowTraq Q3/16
      • Changes in FlowTraq Q2/16
      • Changes in FlowTraq Q1u1/16
      • Changes in FlowTraq Q1/16
      • Changes in FlowTraq Q4/15
      • Changes in FlowTraq Q3/15
      • Changes in FlowTraq Q2/15
      • Changes in FlowTraq Q1/15
      • Changes in older versions of FlowTraq
  • Installation
    • System Requirements
      • Server Hardware Requirements
        • Estimating DISK requirements
        • Estimating RAM requirements
      • Platform Requirements
    • Deploying the Virtual Appliance
      • Memory and Disk
        • vApp CPU settings
        • vApp RAM settings
        • vApp Disk settings
      • Using a remote FlowTraq server
    • FlowTraq Server Daemon Installation
      • Preparing For Installation
      • Windows
      • Unix (including Mac OS X)
    • Installing the Web Portal
      • Software Prerequisites
      • Installation Overview
      • Detailed Installation Guides
        • OpenSuSE Linux 11 - Installation Guide
        • Ubuntu Linux 16 (Trusty Tahr) or later - Installation Guide
        • CentOS 6.3 - Installation Guide
        • FlowTraq Web Interface on FreeBSD 8.2
          • Compiling the Prerequisites
          • FlowTraq Installation
      • Troubleshooting
      • Access
    • Upgrading FlowTraq
      • Upgrading to Q3/15 or Later
        • Path 1 (Virtual Appliance upgrade)
        • Path 2 (Removing NBI; no detectors)
        • Path 3 (Removing NBI with detectors)
        • Migrating Detectors
          • Before Upgrading
          • After Upgrading
      • FlowTraq Virtual Appliance
      • Windows (Server only)
      • Mac OS (Server only)
      • Linux (Server and FlowTraq Web)
    • FlowTraq Desktop Client
      • Preparing For Installation
      • Windows
      • Mac OS X
      • Unix
    • Designing and configuring Archive storage
    • Initial Configuration
      • FlowTraq Login
      • Entering a License Key
      • Changing your Password
    • Backing up a FlowTraq Install
      • Full Backup
      • Compact Backup (Configuration Only)
      • Restoring from Backup
    • Migration
    • Automatic Denial of Service (DOS) Mitigation
  • Operation
    • Getting Started
      • Verifying Your Exported Data
      • Describing Your Network for FlowTraq
      • Creating an Alert Policy
      • Next Steps
    • FlowTraq User Interface
      • The Dashboard
        • Customization
      • The Workspace
        • Workspace Graph
          • Drag-to-Zoom
        • Workspace Tables
          • Click-to-Filter
          • Friendly Names
          • Menu Customization
        • Navigation
          • Filtering
            • Address Block Filtering
            • Client vs. Server vs. Either Behavior
            • Client and Server vs. Sender and Receiver
            • Special Filters
            • List of Filter Elements
          • View Selection
            • Pair-wise Views
            • Sent vs. Received vs. Total
            • Special Primary Rankings
            • Unique Count Views
          • Time Navigation
            • Absolute and Relative Time
            • Time Navigation
            • RAM vs Disk based queries
        • Viewing Raw Session Data
    • Policies and Alerting
      • Policy Page Overview
        • Reading the Policy Page
        • Configuring Alert Policies
          • Configuring Actions
      • Alerting
        • Alert Page
          • Summary Notifications on the Dashboard
        • Retrieving Alerts via the Command Line
    • Command Line Interface
      • Overview
      • Retrieving Raw Session Data from the Command Line with ftsq
      • Time Navigation
      • Filter String Syntax
      • Retrieving Statistical Queries from the Command Line with ftstat
      • Assigning Friendlynames from the Command Line with ftname
      • Generating IPFIX with ftsq
      • Session Key Reauthentication
      • Server Health Monitoring With ftum
  • Administration
    • Partition Management
      • Defining Internal Blocks
      • Assigning Flows to Partitions
      • Managing Partitions from the Command Line with ftgroup
    • User Management
      • Managing Users in FlowTraq
        • User Privileges
        • Adding and Removing Users
        • User Filter Control
      • Managing Users from the Command Line with ftum
      • Configuring LDAP External Authentication
      • Configuring TACACS+ External Authentication
    • Email Reporting Configuration
      • Global Configuration
    • Traffic Group Management
      • Traffic Group Creation
      • Traffic Group Deletion
      • Traffic Group Statistics
    • Flow Deduplication Using Rings
    • Advanced Server Administration
      • Starting and Stopping FlowTraq Server
        • Windows
        • Mac OS X
        • Linux
        • BSD
        • Solaris
        • Signaling a 'Soft' Restart
      • Backing Up the Session Database
      • Clearing the FlowTraq Session Database
      • The FlowTraq Server Configuration File: flowtraq.conf
        • Making Changes to flowtraq.conf
        • Configuration File Format
        • Configuring TACACS+ External Authentication
        • Configuring FlowTraq Clustering
        • Configuring LDAP External Authentication
          • LDAPS using stunnel
      • Host Status
    • Cluster Administration
      • FlowTraq Portal Node Status
      • Adding Nodes
      • Removing Nodes
      • Configuring Syslog Export of System Status
      • Troubleshooting
        • Non-Responsive Nodes
        • Heavy Load
    • NetFlow Export Configuration
      • Cisco Device Configuration
        • Flexible NetFlow
          • Records
          • Exporter
          • Monitor
          • Finalizing
        • Traditional NetFlow (newer IOS)
        • Traditional NetFlow Configuration
      • VMWare vSphere 5.1 (or later)
      • Open VSwitch SDN
      • Using Flow Exporter
        • Installation
          • Hardware Requirements
          • Deployment Options
          • Linux, BSD, Solaris, Mac OS X
          • Windows Installation
        • Configuration
  • Appendices
    • FlowTraq Web API Reference
      • Version 3
        • Authentication
          • Parameters for login
        • Flow Records - Full JSON
          • Request Parameters
          • Response Parameters
          • FlowObject definition
        • Flow Records - Compact Mode
          • Request Parameters
          • Response Parameters
        • Flow Records - Count
          • Request Parameters
          • Response Parameters
        • Flow Statistics Table
          • Request Parameters
          • Response Parameters
        • Alert Retrieval
          • Request Parameters
          • Response Parameters
        • Traffic Groups and Blacklists
        • User Management
          • User Preferences
        • FlowTraq Configuration
        • Status Information
        • Exporter Management
      • Version 2
      • Version 1
        • Authentication
          • Request Parameters
          • Response Parameters
          • Example
        • Retrieving Processed FlowTraq Views
          • Request Parameters
          • Response Parameters
          • Example
        • Retrieving Raw NetFlow Sessions
          • Request Parameters
          • Response Parameters
          • Example
    • FlowTraq Mitigation Plugins
      • Overview
      • Manual Plugin Installation
      • Alerting Process and Arguments
        • Threshold Alerts
        • Distributed Denial of Service (DDoS) Alerts
        • Blacklist Alerts
        • Data Exfiltration Alerts
        • New Server Alerts
        • New Client Alerts
      • Alert Annotation
      • Plugin Files
        • Field for Annotating Alerts
    • Legal Notices
      • END USER LICENSE AGREEMENT FOR FLOWTRAQ
      • Third-Party Software Components
        • Restlet
        • JFreeChart
Search
 

Search Highlighter (On/Off)