]> projects.mako.cc - selectricity/blob - vendor/plugins/sitealizer/README
added new tests and fixtures
[selectricity] / vendor / plugins / sitealizer / README
1 = Sitealizer Web Stats plugin for Rails 
2 This plugin lets you track visitors, referrers, robots, search terms and more. And it shouldn’t influence your site’s performance because it only saves the basic visitor information (after every 10(default) visits) in a threaded process and all the data processing is done when viewing the stats.
3
4 == Author
5 Thiago Jackiw:: tjackiw at gmail dot com
6
7 == Current Release
8 The current stable release is v1.1 released on 03-20-2007. 
9
10 == License Info
11 Please refer to the LICENSE[link:files/LICENSE.html]
12
13 == Installation
14 On your Rails' root directory, just type
15
16   script/plugin install http://opensvn.csie.org/sitealizer
17
18 and add the following line to your config/routes.rb:
19
20   map.connect '/sitealizer/:action', :controller => 'sitealizer'
21
22 == Upgrading from SiteMeter
23 If you had previously installed 'sitemeter' you need to run the following command after installing Sitealizer, otherwise your stats <b>will not be imported</b>:
24
25   rake sitealizer:remove_sitemeter
26
27 You also need to change: 
28
29   * include SiteMeter TO Include Sitealizer
30   * before_filter :use_site_meter TO before_filter :use_sitealizer
31   * map.connect '/sitemeter/:action', :controller => 'sitemeter' TO map.connect '/sitealizer/:action', :controller => 'sitealizer'
32
33 == Configuration
34 There are four configuration options that can be changed under sitealizer/lib/config.yml:
35 <em>access_type</em>:: Accepts <em>private</em> or <em>public</em> as the value. <em>Private</em>: you have to enter the username and password below in order to view the stats. <em>Public</em>: Anyone can view your site's stats
36 <em>username</em>:: This username will be used to log in to your Sitealizer
37 <em>password</em>:: This password will be used to log in to your Sitealizer
38 <em>queue_size</em>:: The number of visitors in the queue before saving the stats to the DB. Default is 10. Minimum size shouldn't be under 5
39
40 == Usage
41 To track the visitors on your entire application, just edit your ApplicationController(application.rb):
42
43   class ApplicationController < ActionController::Base
44     include Sitealizer
45     before_filter :use_sitealizer
46   end
47
48 Or to track specific controllers:
49
50   class ApplicationController < ActionController::Base
51     include Sitealizer
52   end
53
54   class MyController < ApplicationController
55     before_filter :use_sitealizer
56   end
57
58 == Viewing the stats
59 To view your stats just add "/sitealizer" to your main url:
60
61   http://www.example.com/sitealizer
62
63 == Using Sitealizer?
64 I’d like to include your site on the list below. Please send me an email (tjackiw at gmail dot com) with your site’s url.
65 * www.californiabusinesslist.com
66 * www.nottr.com
67 * www.bacotp.com
68
69 == Getting help
70 You can always send me an email (tjackiw at gmail dot com) if you have any questions.
71
72 == Bugs/Patches
73 Please report the bugs you find by opening tickets here[https://opensvn.csie.org/traccgi/sitealizer/newticket]
74
75 == Special Thanks to:
76 * RubyForge (www.rubyforge.org)
77
78 == Other plugins by the Author:
79 * acts_as_solr (http://acts-as-solr.rubyforge.org)
80
81 == Release Information
82 Released under the MIT license.

Benjamin Mako Hill || Want to submit a patch?