Skip to content

INSTALL.md

Latest commit

 

History

History
124 lines (70 loc) · 5.54 KB

INSTALL.md

File metadata and controls

124 lines (70 loc) · 5.54 KB

Calagator

Setup

To use Calagator, you'll need to:

  1. Install git 1.5.x or newer, a distributed version control system. Read the Github Git Guides to learn how to use git.
  2. Install Ruby, a programming language. You can use MRI Ruby 1.8.6, MRI Ruby 1.8.7, or Phusion REE (Ruby Enterprise Edition). Your operating system may already have Ruby installed or offer it as a prebuilt package.
  3. Install RubyGems 1.3.x, a tool for managing software packages for Ruby. If you already have rubygems installed, you may need to update it by running gem update --system as root or an administrator.
  4. Install SQLite3, a database engine. Your operating system may already have Ruby installed or offer it as a prebuilt package.
  5. Install Ruby on Rails, a web development framework. You should run gem install rails -v '~> 2.3.10' --no-ri --no-rdoc as root or an administrator.

Additional, but out of date, instructions can be found at http://code.google.com/p/calagator/wiki/DevelopmentSoftware

Checkout

To get the Calagator source code:

  1. Follow the Setup instructions above.
  2. Run git clone git://github.com/calagator/calagator.git or equivalent, which will create a calagator directory with the source code. Go into this directory and run the remaining commands from there.

Configuration

To configure Calagator:

  1. Follow the Checkout instructions above.
  2. Initialize your database, run rake db:migrate db:test:prepare
  3. Optionally setup API keys so that maps display and such, see 'API Keys'.

Development

To run Calagator in development mode:

  1. Follow the Configuration instructions above.
  2. Start your search service if needed, see "Search engine" below for details.
  3. Start the Ruby on Rails web application by running ./script/server (UNIX) or ruby script/server (Windows).
  4. Open a web browser to http://localhost:3000/ to use the development server
  5. Read the Rails Guides to learn how to develop a Ruby on Rails application.
  6. When done, stop the Ruby on Rails server script/server by pressing CTRL-C.
  7. Stop your search service if needed, see "Search engine" below for details.

Customization

If you want to customize your Calagator, do NOT just start modifying files in app, public and themes/default. Please read the instructions in themes/README.txt for how to use the theming system.

Security and secrets.yml

This application runs with insecure settings by default to make it easy to get started. These default settings include publicly-known cryptography keys that can allow attackers to gain admin privileges to your application. You should create a config/secrets.yml file with your secret settings if you intend to run this application on a server that can be accessed by untrusted users, read the config/secrets.yml.sample file for details.

API Keys

The application uses a number of API keys to communicate with external services.

  • Yahoo! Upcoming: To import events from Upcoming, the application can use a public key, but for production use, you should really get and use your own API key. See the config/secrets.yml.sample file's upcoming_api_key section for details.

  • Google Maps: To display Google maps, you must get an API key. For details, see the config/geocoder_api_keys.yml.example for details.

Search engine

You can specify the search engine to use in your config/secrets.yml file:

sql

Default search engine which uses SQL queries. Requires no additional setup, dependencies or service. Does not provide relevance-based sorting. Provides substring matches.

sunspot

Optional search engine that uses the Sunspot gem. Requires additional setup, dependencies and service. Provides relevance-based sorting. Does not provide substring matches.

To use, you will need to install Java 1.6.x, a programming language used to run the search service.

You will then need to initially populate your records by running commands like:

rake RAILS_ENV=production sunspot:solr:start
rake RAILS_ENV=production sunspot:reindex:calagator

You can start the Solr search service a command like:

rake RAILS_ENV=production sunspot:solr:start

You can stop the Solr search service a command like:

rake RAILS_ENV=production sunspot:solr:stop

acts_as_solr

Optional search engine that uses the acts_as_solr gem. Requires additional setup, dependencies and service. Provides relevance-based sorting. Provides substring matches. However, has severe performance problems that may slow down creating and editing records.

To use, you will need to install Java 1.6.x, a programming language used to run the search service.

You will then need to initially populate your records by running a command like:

rake RAILS_ENV=production solr:rebuild_index

You can start the Solr search service a command like:

rake RAILS_ENV=production solr:start

You can stop the Solr search service a command like:

rake RAILS_ENV=production solr:stop

Production

Calagator.org runs on Ubuntu Linux, Phusion REE (Ruby Enterprise Edition) and Phusion Passenger.