Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
142 lines (121 sloc) 6.5 KB
<httml>
<head>
</head>
<body style="padding: 0px 20px 20px 20px">
<h1>Plures Multi Website Analytics 1.3</h1>
<h2 style="font-weight: normal">Copyright (c) 2017<br>
v1.1 originally written by João Ferreira</h2>
<h2>INSTALLATION</h2>
<ol>
<li>Unpack the files and upload to the website where you're going to save the analytics</li>
<li>Load "plures.php" on your browser (e.g.: http://www.mysite.com/plures.php) and follow on-screen instructions</li>
<li>If you don't have a MySQL database created, you'll have to create one on your webhost's control panel.</li>
<li>Register a new website</li>
<li>Copy the script code and insert on the target website.</li>
<li>Repeat steps 4-5 for any other websites you may have</li>
<li>Click "SETTINGS" and configure it to your preferences:<br>
- Setup a password if you want to keep your analytics private.<br>
- Setup your ip (if fixed); and/or a cookie in order for your views to not be part of the analytics.
<li>The main page will begin to display analytics as soon your website(s) get activity.</li>
<li>Be sure to delete files inside "tmp" folder.</li>
</ol>
<h2>REQUIREMENTS</h2>
<ol>
<li>PHP >= 5.3 (compiled with mysqli)</li>
<li>MYSQL Database >= 4.1</li>
</ol>
<h2>HOW DOES IT WORK?</h2>
Plures Multi Website Analytics counts analytics through two methods:
<ul><li><b>Sessions/Cookies</b> - Users that accept cookies are tracked directly using server sessions (saved in cookies) and cookies. This kind of users generate a visit per browser session, if the session is older than the pre-defined value, a visit is counted.</li>
<li><b>Host/Last Activity</b> - Users that do no accept cookies, sessions do not work without cookies, so, this users need to be tracked indirectly through their host (if any), last activity and the minimum visit age constant defined in "plures.settings.php". Every time a page view is older than the pre-defined value, a visit is counted.</li>
</ul>
<h2>NOTES</h2>
<ul>
<li>For consistency, analytics are always counted in GMT time, no matter your timezone or your server's timezone.</li>
<ll>The timezone option only applies to already recorded dates.</li>
<li>Genuine return visits are the visits where the user returns to the website using a cookie tag, previously set on the first visit. The system tries to ensure the users not accepting cookies have a minimum visit age limit, in order to stop them from generating "views" visits.</li>
<li>A unique visitor tagged as "Genuine Return Visitor" is a visitor that has at least one Genuine return visit</li>
<li>If the remote website visitor has javascript disabled, the counter will still work, the only difference is that the referrer information won't be retrieved.</li>
<li>Monthly uniques and daily uniques are independent from each other (e.g.: if a first time user visits the website for 2 consecutive days, he/she will be counted as 1 monthly unique and 2 daily uniques)</li>
<li>All analytics via javascript are from page views that were parsed by a web browser. Non Viewed traffic is not tracked. The filtered views are from automated identities that actually parsed the page source.</li>
</ul>
<h2>
TABLE HEADERS EXPLANATION
</h2>
<h3>Month Totals</h3>
<ul>
<li><b>Visits</b> - Raw visits</li>
<li><b>Views</b> - Page hits</li>
<li><b>Unique visitors</b> - Genuine Unique users certified by ip/cookie</li>
<li><b>Return Visitors</b> - Genuine Unique return visitors certified by ip/cookie + Non Genuine (If any)</li>
<li><b>Return Visits</b> - Genuine/Non Genuine Visits made by the Return visitors described above</li>
<li><b>Referrers</b> - Remote origins of traffic (Does not include search engines)</li>
<li><b>Keywords</b> - Keywords related to Search Engine Traffic, if the keyword is missing, it will be set as "Undefined".</li>
<li><b>Req.</b></li> - Requested Pages
<li><b>Interfaces</b> - Chart/Tables, statistic containers.</li>
</ul>
<h3>Day Totals</h3>
<ul>
<li><b>Unique visitors</b> - Genuine Unique users for the given day certified by ip/cookie</li>
<li><b>Visits</b> - Raw visits</li>
<li><b>Views</b> - Page hits</li>
</ul>
<h2>
FOLDER STRUCTURE
</h2>
<ul>
<li>
<b>includes</b>
<ul>
<li>
<b>client</b>
<ul>
<li><b>plures.style.css</b> - Styles</li>
<li><b>plures.script.js</b> - Javascript</li>
</ul>
</li>
<li><b>images</b>
<ul><li>- Image files used by this software</li></ul>
</li>
<li><b>plures.analytics.class.php</b> - Analytics class (counts analytics)</li>
<li><b>plures.functions.php</b> - Standalone functions</li>
<li><b>plures.interface.class.php</b> - MyInterface Class (Prints templates and processes forms)</li>
<li><b>plures.mysqldb.class.php</b> - MySqlDb Class (Database)</li>
<li><b>plures.settings.php</b> - MySQL Connection details / Advanced settings</li>
<li><b>plures.templates.php</b> - Templates</li>
</ul>
</li>
<li>
<b>tmp</b>
<ul>
<li><b>plures.sql</b> - MySQL tables Dump</li>
<li><b>MySQL_update_v1.3.sql</b> - v1.3 MySQL table upgrade</li>
</ul>
</li>
<li><b>plures.php</b> - Interface</li>
<li><b>pluresc.php</b> - Counter</li>
<li><b>README.txt</b> - README File</li>
<li><b>README.html</b> - This File</li>
</ul>
<h2>ADVANCED SETTINGS (plures.settings.php)</h2>
<ul>
<li>MySQL Database Connection Details</li>
<li>Cookie Prefix</li>
<li>Maximum Session Age</li>
<li>Minimum Visit Age</li>
<li>Chart Customization</li>
<li>Days Table Margin</li>
<li>Login Temporary Password</li>
<li>Disable Login Form</li>
</ul>
<h2>CHART Customization Reference</h2>
<img src="includes/images/chart_custom_reference.png"><br>
You can customize the main chart by editing file <b>includes/plures.settings.php</b>, use the image above as reference.
<h2>SECURITY</h2>
<ul>
<li>The analytics interface can be protected by a password. In order to reset the password, a temporary password can be set on "plures.settings.php". This setting shall only be used for recovery purposes, it must be empty when not needed. Using it to store the password for long periods may lead to security issues.</li>
<li>Since the password works through cookies (your browser logs you in automatically using the stored information), for increased security, the login form can also be disabled in "plures.settings.php". In case you need to reset your password, you can re-enable it.</li>
</ul>
<div style="margin-top: 50px; text-align: center">Plures Multi Statistic Tracker &copy 2017</div>
</body>
</html>