Announcements

I will be out of the office and traveling from the 26th of May until the 31st of May. I will try to answer your support questions as soon as I can.

Steven Palmer

Traffic Guide

This guide will help you set up CoalaWeb Traffic quickly and easily taking full advantage of all its features. When you install a CoalaWeb extension all the parts of the system will be installed at the same time making installing, upgrading and uninstalling a breeze.

Table of Contents

  1. Overview
  2. Component Guide
  3. Traffic [M]
  4. Traffic Pro [M]
  5. Plugins
  6. Need More Help?

Overview

CoalaWeb Traffic is a Joomla extension designed to keep track of the visitors to your site. You can choose to display the modules and let visitors see and be amazed by your traffic or unpublish the module and view your website statistics in the Admin area.

When installing all the parts of the system will be installed at the same time making installing, upgrading and uninstalling a breeze.

Component

Control Panel

The Control Panel as seen below it is designed to be an easy starting point, think of it as the components head quarters. While carrying out tasks you can easily jump from the Control Panel to the different sections and then return before moving onto the next one. [Figure-1]

Figure-1

Visitors

Figure-2

The Visitors section is where all the visitors to your site are listed. The visitors are displayed with the following information.

  • Their IP address (unless not stored RAW)
  • Browser Type
  • Browser Version
  • Platform (Operating System)
  • Referer Link
  • The date they visited
  • The time they visited
  • Name assignment (optional)
  • Their Location (Only with the Geo Database Installed)

Both Core and Pro users have sort and search options. To sort the visitor information you can click the column Heading or use the Select list in the top right. The avaliable sorting options are:

  • IP
  • Browser
  • Platform
  • Date
  • Country
  • ID

You also have a search box where you can choose to enter an IP or Date to search for specific visitor information. [Figure-2a]

Figure-2a

Pro subscribers also get Filter options which can be used by clicking the Search Tools button at the top and include Browser, Platform and Country select lists. [Figure-2b]

Figure-2b

IP Categories

Figure-3

To make it easier to organize your Know IPs you can create categories to associated them with. For example you could create a category called Robots and then add all the known robots in your Knownips list to this category. [Figure-3a]

Figure-3a

Known IPs

Figure-4

The next section is the Known IPs section which contains some powerful tools for controlling what is counted by Traffic. [Figure-4a].

Figure-4a

IP Formats

Figure-3

When adding IPs to a Known IP entry you have several options, you can specify an IP or IP range in the following formats:

  • Single IP - 192.168.1.1
  • Simple IP Range - 192.168.1.1-192.168.1.255
  • Implied IP Range - 192.168.1.

Scenarios

Your Own IP:

If you just want to keep an eye on your own IP for example you could create a new entry give it a Name and Description add your IP and leave Count to yes. Now in the Visitors view you can see your visits easily by look down the IP Owner column. [Figure-3].

Block by IP:

If you want to stop an IP from being counted by Traffic create a new entry give it a Name and Description add the IP and set Count to No. Now that particular IP will not appear in the visitors list as it is not counted by the system any more.

Block by Name:

If you want to stop a robot from being counted by Traffic based on it's Name create a new entry give it a Name and Description add the Robot Name and set Count to No. Now that particular robot will not appear in the visitors list as it is not counted by the system any more.

Note: The most reliable way to identify visitors is by their IP the name information comes from their user agent string which isn't always supplied.

GEO Location

CoalaWeb Traffic gives you the option to identify your visitors Countries and Cities of origin based on their IP addresses. [Figure-5].

Figure-5

How Geo Location Works

CoalaWeb Traffic can work in conjunction with MaxMind's Geo databases to help determine location information about your visitors. The Core version of CoalaWeb Traffic uses the (Legacy) GeoLite City database while Pro subscribers get the advantage of using the current GeoLite2 City database with extend features. The databases are updated very frequently, about once every month. Why so often? IP assignments to countries change all the time in fact by the time we release our extension, the database file is most likely already slightly out of date.

What Will This Affect

This could cause some IP addresses to be identified as coming from the wrong location. Updating the file regularly will give you much better country and city accuracy. MaxMind claims an accuracy of 99.5% for its free Geo databases so please bear in mind that this means that some IP addresses might be reported wrongly.

Do I Have To Install It?

No you do not. The system will continue to count and store your website traffic with out the database installed the only difference is that you won't see Country or City information associated with their IP addresses.

Note: It's a good idea to inform visitors in your privacy policy or TOS that you are collecting their information.

Installing the Geo Database

If you don’t have the GeoLiteCity database installed you will receive a notice message. To take advantage of CoalaWeb Traffics inbuilt ability to tell you a visitors country and sometimes their city follow the steps below. [Figure-5a].

Figure-5a

To make it easier to know if you will need to upload the database manually I have added a Upload Minimum Requirements check list that will display in the Geo Location view. [Figure-5b].

Figure-5b

If your system doesn't meet the minimum requirements but its close I recommend trying the easy way first before moving on to the manual method.

Easy Install

First click the Upload Geo Database blue button this will retrieve the latest version of the database from the Maximind website and upload it to your website's tmp directory. [Figure-5c].

Figure-5c

If everything went according to plan you will receive a conformation message that it uploaded correctly. [Figure-5d].

Figure-5d

The next step is to Unzip the file to the CoalaWeb Traffic geoip directory where it can be accessed and used to determine your visitors locations. If the database uploaded correctly in the last step you will now have a Unzip icon in the top tool bar, click this to start the unzip process. [Figure-5e].

Figure-5e

Once again if everything goes according to plan you receive a conformation message that the file was unzipped correctly and also the message at the top of the page will turn green with today's date. [Figure-5f and Figure-5l].

Figure-5f

Figure-5l

Now CoalaWeb Traffic will automatically add country and city information to your visitor records as they are collected. To keep the location information as accurate as possible just carry out this procedure at regular intervals.

Note: Please be patient when Uploading and Unzipping the database it may take some time due to the size of the file.

Manual Install

If you re using the Core version of Traffic and you couldn't install the database the easy way no problem lets just do it the manual way by following these steps.

Note: To avoid issues please follow these steps exactly as they are written.

Download the latest MaxMind GeoLiteCity database HERE. [Figure-5g].

Figure-5g

Now that you have the database downloaded the next step is to extract it. Once it has completed the extraction process you will have a file named GeoLiteCity.dat [Figure-5i].

Figure-5i

The next step is convert the name to lowercase geolitecity.dat. [Figure-5j].

Figure-5j

The last step is to upload your newly renamed database file to the following location:

administrator/components/com_coalawebtraffic/assets/geoip

The database file should have 644 permissions. [Figure-5k].

Figure-5k

Now if everything went according to plan you should now start to see Country and City data in the Visitors view.

Manual Install [Pro]

If you re using the Pro version of Traffic and you couldn't install the database the easy way no problem lets just do it the manual way by following these steps.

Note: To avoid issues please follow these steps exactly as they are written.

Download the latest MaxMind GeoLite2 City database HERE. [Figure-5g-a].

Figure-5g-a

Now that you have the database downloaded the next step is to extract it. Once it has completed the extraction process you will have a file named GeoLite2-City.mmdb [Figure-5i-a].

Figure-5i-a

The next step is convert the name to lowercase geolite2-city.mmdb. [Figure-5j-a].

Figure-5j-a

The last step is to upload your newly renamed database file to the following location:

administrator/components/com_coalawebtraffic/assets/geoip/v2

The database file should have 644 permissions. [Figure-5k-a].

Figure-5k-a

Now if everything went according to plan you should now start to see Country and City data in the Visitors view.

Charts [Pro]

Pro subscribers also get access to a series of Charts which allow you to quickly see your visitor data grouped in the following ways.

Visitors

A quick summary of your visitors displayed in a graph based on quantity and date accompanied by a summary table. [Figure-14].

Figure-14

Countries

A color coded map visual representing your visitors and their countries accompanied by a summary table. [Figure-14a].

Figure-14a

Cities

A color coded pie chart representing your visitors and their cities accompanied by a summary table. [Figure-14b].

Figure-14b

Browsers

A color coded pie chart representing your visitors and their browsers accompanied by a summary table. [Figure-14c].

Figure-14c

Platforms

A color coded pie chart representing your visitors and their platforms accompanied by a summary table. [Figure-14d].

Figure-14d

CSV Report

If you want to export the visitors currently stored in your database start by clicking the CSV Report button in the Control Panel.

Figure-6

You should get a pop up that similar to the image below if not make sure it's not being blocked by something such as your browser settings. [Figure-6c]

Figure-6c

Next save the file to your local computer and then open it with your application of choice. In this example I will be using LibreOffice but the procedure will be similar with other applications. First I have to import it before I can work with the data so after a double click I'm confronted with the window below. [Figure-6d]

Figure-6d

I have chosen to import it with the default settings which results in the data being laid out in a sheet. [Figure-6e]

Figure-6e

You can now format, filter and save the data as you wish.

Purge

Figure-32a

The Purge button will delete all of the traffic records current stored in the Traffic database tables. To make sure you haven't accidentally press it you will get a popup asking you to confirm your choice. [Figure-32b]

Figure-32b

After it has completed you get a confirmation message or an error message if it was unable to carry out the task. [Figure-32c]

Figure-32c

Optimize and Repair [Pro]

Figure-33a

Pro subscribers also get an Optimize button which will attempt to repair and optimize all the Traffic database tables. To make sure you haven't accidentally press it you will get a popup asking you to confirm your choice. [Figure-33b]

Figure-33b

After it has completed you get a confirmation message or an error message if it was unable to carry out the task. [Figure-32c]

Figure-33c

Add Robots [Pro]

Figure-32a

The Add Robots button allows Pro subscribers to auto populate the Known IP list with a list of known Robots instantly stopping them from being counted. To make sure you haven't accidentally press it you will get a popup asking you to confirm your choice. [Figure-32b]

Figure-32b

After it has completed you get a confirmation message or an error message if it was unable to carry out the task. [Figure-32c]

Figure-32c

The Add Robots system will compare the current list to what you have stored and add any new robots so I recommend running it after each update.

Inbuilt Help

Figure-7

In the control panel or the tool menu you have a help icon that when clicked will open a pop up wrapper of this specific guide. This gives you an easy way of checking the functionality of a particular item without leaving the control panel. [Figure-7a]

Figure-7a

Extension Options

Figure-8

In the control panel or the tool menu you have a Options icon that when clicked will open a series of extension options.

1. General Options

The first option in this section is the Locktime this is the amount of time that must pass before a particular IP will be counted again. It is measured in minutes and 1440 (Full day) is the default. [Figure-8]

The next option is Week Start which allows you to choose which day you want the calculations for the Weeks visitors to start from. This only affects the week count in the front end module and the back end statistics area of the control panel. [Figure-8]

The last option in this section is the Preset Counter this number will be added to the current Total so its good for when you move a site or to bump up the visitors. This only affects the total count in the front end module and the back end statistics area of the control panel. [Figure-8a]

Figure-8a

2. Storage [Pro]

The first option in th is section is to turn on or off the storing of IPs in Raw format otherwise they will only be stored in an unreadable hash format. If you choose no for this option then in the visitors view Not Stored Raw! will be displayed in the IP column and every visitor recorded after that will not have its IP stored in raw format in the database. [Figure-8e]

The second option is to turn on or off the storing of Geo location information. Even if you are not storing IPs in their raw format you can still have Geo information recorded as long as you have uploaded a Geo database. [Figure-8e]

Figure-8e

3. Robots [Pro]

The option in this section will use Joomla's JApplicationWebClient class to block a few well known robots from being counted. This will only detects basic robots if you wish to block additional robots use the KnownIPs list. [Figure-8f]

Figure-8f

4. Cleanup

In this section you can control the automatic clean up of the database to stop the tables filling up with data. I recommend having this set to on and the second option of how many Records to Keep will depend on your circumstances. [Figure-8b]

Figure-8b

5. Project Honeypot

Project Honeypot is a collective effort to detect spammers, email harversters and crackers. Its HTTP:BL service allows participants to query the IP addresses of their visitors and figure out if it is a malicious user behind it. If you enable this feature, CoalaWeb Traffic will check the IP address of each visitor and, if it is a malicious user, it will not count them. [Figure-8b]

Figure-8b

Note: CoalaWeb Traffic does not block visitors from your site only from being counted by the Traffic system.

Use Project Honeypot

  • This option is an easy one it turns the feature on and off

API key

  • Enter your HTTP:BL key. You can sign up for Project Honeypot and get your key at http://www.projecthoneypot.org/httpbl_configure.php.

Block suspicious

  • Sometimes Project Honeypot is not sure if an IP belongs to a spammer or someone who made a couple of bad decisions while surfing the web. In this case the IP is marked as "suspicious". The default behaviour is to not block these IPs.

Block Search Engines

  • If you don't want search engines being counted as visitors to your site you can turn this on. This does not guarantee that all search engines won't be counted but it's a good start.

Minimum Threat (0-255, default 25)

  • Project Honeypot uses a logarithmic "threat rating" to rank the possibility of a specific IP being a spammer. This options defines the minimum threat level an IP must have before it's blocked. A value of 25 means that this IP has submitted 100 spam messages on Project Honeypot's spam catching honeypots and is usually a safe indication that it belongs to a spammer. Do note that the rating is logarithmic. A value of 50 means 1,000 spam messages and a value of 75 means one million spam messages. Do not set it to values over 50, as you will most likely never block any spammer at all.

Maximum Age

  • Project Honeypot reports when was the last time this IP was caught sending spam messages. The older this is (the higher the age is), the less likely is that this IP is still used by a spammer. You can chose here what will be the maximum reported age that will be blocked. The default value of 30 means that IPs which have submitted a spam message in the last 30 days will be blocked.

6. Charts

The options in this section control the amount of records displayed in the Charts. [Figure-8c]

Figure-8c

7. Updates

The CoalaWeb Contact extension integrates with the inbuilt Joomla Update system so both Core and Pro users can keep their extension up to date. For Core users when you see updates listed in the Joomla update manager feel free to select it and update.

For Pro subscribers you will need to make sure you still have a valid subscription and that you have entered your Download ID in either the Control Panel input field. [Figure-28]

Figure-28

Or through the component configuration options under Updates. [Figure-28a]

Figure-28a

TIP: To stop any typos I recommend copying and pasting the Download ID and also to check for no spaces at the end.

Where can I find my Download ID?

To see your Download ID you will need to log into coalaweb.com and then go to:

Members -> My Subscriptions

You will then see the ID displayed in the module titled Download ID. [Figure-28b]

Figure-28b

TIP: To stop any typos I recommend copying and pasting the download ID and also to check for no spaces at the end.

8. Permissions

Lastly you have the permissions used to control access tothe CoalaWeb Traffic component. [Figure-8d]

Figure-8d

CoalaWeb Traffic [M]

The CoalaWeb Traffic module has a huge list of options so we have broken them up into several sections which are explained in detail below.

If you have a multilingual website please leave text fields found through out the module configuration blank and instead use language files to control the text or create a separate module for each language.

General Display Options

To make it easy to explain I have broken this section up into two parts.

Part 1 Digital Counter

First you can choose if you want to display the digital counter section at all maybe you only want to display individual counters. Next you can choose how many digits you want to be displayed. The last option in this section is to choose a theme for your digital counter. [Figure-9]

Figure-9

Part 2 Individual Counters

First you can choose if you want to display the individual counters section at all maybe you only want to display a digital counter. The next option is to choose a theme, this will affect which icons are displayed along side the individual counters or you can choose to have no icons. The next option allows you to turn on or off a horizontal line at the bottom of the counter section.

Next you have the ability to turn on or off the display for today, yesterday, this week, this month and total it's up to you which ones you want to display. Under each of these options is a text box where you can assign a word to be displayed next to the item. [Figure-9a]

Figure-9a

Module Layout Options

The first two options control the width of the counter section and the overall module width.

The next option is the module layout you have three options to choose from.

  • Default - The vertical layout allows both the counters and visitor info.
  • Horizontal - The horizontal layout only allows counters.
  • Compact - The compact layout only displays the horizontal text and the total counter.

The next option is the horizontal text this will display to the left of both the horizontal and compact layouts. The last option is the separator that will display between items in both the horizontal and compact layouts. [Figure-10]

Figure-10

Visitor Display Options

This section controls what information about the visitor will be displayed within the Traffic module.

To make it easier to explain I have broken this section into two parts.

Part 1

First you can choose if you want to display the visitor information section at all. Next are the Title configuration options, you can to choose to display one including the title text, it's format and it's alignment. The next option allows you to turn on or off a horizontal line at the bottom of the visitor section. [Figure-11]

Figure-11

Part 2

In this section you have the option to turn on or off the following items as well as choosing their label text. [Figure-11a]

  • IP
  • Browser
  • Operating System

Figure-11a

Who is Online Options

Due to the flaws in the Joomla method of telling who is online I have created my own that uses cookies and a database table to keep track of who is online. The data is then retrieved and displayed in this section of the module.

First you can choose if you want to display the who is online section at all. Next are the Title configuration options, you can choose to display them including their title text, their format and alignment. The next option allows you to turn on or off a horizontal line at the bottom of the who is online section. [Figure-12]

Figure-12

Advanced Options

The CoalaWeb Traffic module also has a few of what I consider Advanced Options such as the option to turn on or off the loading of the Core CSS and or assigning your own Custom CSS file. This next option allows you to display the Date and Time at the bottom of the module as well as choosing its Format. You can also assign a Module Class Suffix or whether to use Cache including the Cache Time in this section. [Figure-13]

Figure-13

CoalaWeb Traffic Pro [M]

The CoalaWeb Traffic Pro module has a huge list of options so we have broken them up into several sections which are explained in detail below.

Figure-18

If you have a multilingual website please leave text fields found through out the module configuration blank and instead use language files to control the text or create a separate module for each language.

General Options

This section controls the outer container style and title plus the digital counter options.

To make it easier to explain I have broken this section into two parts.

Part 1 Container

The first option in this section is the choice of Panel style for the outer container the holds the other sections of the module. The next part is a series of options to control the style and layout of the main container title which includes whether to display it, it's format, alignment and which icon to use next to it. [Figure-18a]

Figure-18a

Part 2 Digital Counter

This section cover the display and style of the Digital counter. It can be turned on or off as well as the amount of digits to display and its size. There are also four style options to choose from and the size of the margin below can also be selected. [Figure-18b]

Figure-18b

Layout Options

This section controls the layout of the different sections of the module and how they are displayed on a variety of screen sizes.

Width Guide: Desktop = 960px, Tablet = 768px and Mobile = 480px

The three inner sections of the module can be displayed along side each other depending on avaliable screen size or in one column. These setting will be the default but the module being fully responsive will adapt to the current screen size and changes made to it. [Figure-18c]

Figure-18c

Traffic Options

This section controls the inner Traffic section which contains the individual counters.

To make it easier to explain I have broken this section into two parts.

Part 1 General

The first series of option in this section control the look and feel of the Traffic container which includes it's display and panel style. It also has a series of option to change the style and layout of the Title displayed at the top of the panel including it's icon. [Figure-18d]

Figure-18d

Part 2 Counters

The next series of options control the alignment and layout of the individual counters. They included the alignment of the counters, their overall size and the width of the three parts that make up each counter. The first part of a counter is the Icon then the Text and lastly the Counter. You can adjust these widths to suit their content and your avaliable space. [Figure-18e]

Figure-18e

Next are the individual counter options which allow you to turn them on or off, their text, style and lastly which icon to display with the counter. [Figure-18f]

Figure-18f

Visitor Options

This section controls the inner Visitors section which contains the current visitor information.

To make it easier to explain I have broken this section into two parts.

Part 1 General

The first series of option in this section control the look and feel of the Visitors container which includes it's display and panel style. It also has a series of option to change the style and layout of the Title displayed at the top of the panel including it's icon. [Figure-18g]

Figure-18g

Part 2 Counters

The next series of options control the alignment and layout of the individual counters. They included the alignment of the counters, their overall size and the width of the three parts that make up each counter. The first part of a counter is the Icon then the Text and lastly the Counter. You can adjust these widths to suit their content and your avaliable space. [Figure-18h]

Figure-18h

Next are the individual counter options which allow you to turn them on or off, their text, style, which icon to display with the counter and for the date counter the date format. [Figure-18i]

Figure-18i

Who is Online Options

This section controls the inner Who Is Online section which contains the current who is online information.

To make it easier to explain I have broken this section into four parts.

Part 1 General

The first series of option in this section control the look and feel of the Who Is Online container which includes it's display and panel style. It also has a series of option to change the style and layout of the Title displayed at the top of the panel including it's icon. [Figure-18j]

Figure-18j

Part 2 Counters

The next series of options control the alignment and size of the who is online counter. [Figure-18k]

Figure-18k

Part 3 Who Is Online

Next are the Who Is Online counter options which allow you to turn it on or off, it's text, style and lastly which icon to display with the counter. [Figure-18l]

Figure-18l

Part 4 Flags

Next are the Flag options which allow you to turn them on or off, their alignment and the section's related title option. [Figure-18m]

Figure-18m

Advanced Options

The CoalaWeb Traffic Pro module also has a few of what I consider Advanced Options such as which UIkit prefix to use, by default it is set to CW but if you are using a YooTheme template you may want to change it to UK. You can also assign a Module Class Suffix or whether to use Cache including the Cache Time in this section. [Figure-18n]

Figure-18n

Plugins

There are several plugins crucial to the proper functioning of the CoalaWeb Traffic system. They are explain in detail below.

System Plugin - Count

This plugin is crucial to functionality of the system it quietly counts the visits to your site and then records them in the database. It allows you to count the traffic to your site even with the module unpublished and also ensures all traffic is record regardless of the part of the site that they visit.

This plugin also takes care of blocking visitors from being counted based on your setting in the CoalaWeb Traffic component. [Figure-15]

Note: To ensure proper functionality of CoalaWeb Traffic please make sure this plugin is installed and publish.

Figure-15

System Plugin - Clean

This plugin carries out the automatic database clean up but only if you have it turned on in the Component Options. It will run in the background keeping the current data but delete out the old entries and add them to a running total. It is recommended to turn this feature on. [Figure-16]

Have you chosen automatic database clean up? Then this plugin needs to be installed and published.

Figure-16

System Plugin - Online

This plugin will check who is online, record it to a cookie and to the database and lastly supply the information to the Traffic modules so they can display the currently online visitors. [Figure-17]

Have you chosen to display Who is Online? Then this plugin needs to be installed and published.

Figure-17

Need More Help

Do you have a question that wasn't covered by this GUIDE? Try the FAQ
Do you have a question that wasn't covered by this GUIDE or the FAQ? Then it's time to drop by the Forum

Related Links

Written by Steven Palmer Tuesday, 23 April 2013 Posted in Extensions, Traffic

GET IN TOUCH

We will be glad to help you with any general or technical questions.