aboutsummaryrefslogtreecommitdiffstats

Aclog Build Status Coverage Status

Collects favs and retweets in real time by UserStreams.

Aclog is

Status

Features

  • Collecting favorites and retweets from Twitter Streaming API
  • Protected account support
  • JSON API (OAuth Echo)
  • Atom feed

Not yet / will be implemented

  • Import tweets from Favstar / Favotter / tweets.zip / ..

Requirements

  • Ruby 2.1.0/2.0.0
  • MySQL/MariaDB 5.5.14+ (needs utf8mb4 support)

Installation

Database

  • Create MySQL user

Aclog (Application Server)

  • Clone the source

    $ # We'll install aclog into /var/webapps/aclog
    $ cd /var/webapps
    $ git clone https://github.com/rhenium/aclog.git
    $ cd /var/webapps/aclog
    
  • Configure it

    $ # Copy the example aclog config
    $ cp config/settings.yml.example config/settings.yml
    $ # Edit it
    $ vi config/settings.yml
    
    $ # Copy the example aclog database config
    $ cp config/database.yml.example config/database.yml
    $ vi config/database.yml
    
    $ # Set random secret_token
    $ cp config/initializers/secret_token.rb.example config/initializers/secret_token.rb
    $ sed -i s/replace_here/$(rake secret)/g config/initializers/secret_token.rb
    
    $ # Setup database. This will create database and tables on MySQL server.
    $ rake db:setup
    
  • Install Gems

    $ bundle install
    
  • Start your aclog

    $ # Start Unicorn (Web server)
    $ ./start_unicorn.sh start
    $ # Start Background server
    $ ./start_receiver.sh start
    

Aclog (Collector Clusters)

  • Chdir

    $ cd /var/webapps/collector
    
  • Configure it

    $ # Copy the example collector config
    $ cp settings.yml.example settings.yml
    $ # Edit it
    $ vi settings.yml
    
  • Install Gems

    $ bundle install
    
  • Start collector

    $ RAILS_ENV=production bundle exec ./start.rb
    

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request