Skip to content
Newer
Older
100644 125 lines (73 sloc) 6.65 KB
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
1 Calagator
2 =========
3
4
5 Setup
6 -----
7
6d293a6 @igal Update INSTALL.md to correct some typos and obsolete information.
igal authored Jul 15, 2011
8 You will need to:
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
9
6d293a6 @igal Update INSTALL.md to correct some typos and obsolete information.
igal authored Jul 16, 2011
10 * [Install git](http://git-scm.com/), a distributed version control system. Read the [Github Git Guides](http://github.com/guides/home) to learn how to use *git*.
11 * [Install Ruby](http://www.ruby-lang.org/), a programming language. You can use MRI Ruby 1.8.7, or [Phusion REE (Ruby Enterprise Edition)](http://rubyenterpriseedition.com/). Your operating system may already have it installed or offer it as a pre-built package.
12 * [Install RubyGems](http://rubyforge.org/projects/rubygems/) 1.3.x or newer, a tool for managing software packages for Ruby.
13 * [Install SQLite3](http://www.sqlite.org/), a database engine. Your operating system may already have it installed or offer it as a pre-built package.
14 * [Install Bundler](http://gembundler.com/), a Ruby dependency management tool. You should run `gem install bundler` as root or an administrator after installing Ruby and RubyGems.
15 * Checkout the source code. Run `git clone git://github.com/calagator/calagator.git`, which will create a `calagator` directory with the source code. Go into this directory and run the remaining commands from there.
16 * Install Bundler-managed gems, the actual libraries that this application uses, like Ruby on Rails. You should run `bundle`, which may take a long time to complete.
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 23, 2011
17 * Optionally specify the theme to use, see the **Customizing** section for details.
18 * Optionally setup API keys for external services so that maps will be displayed, see the **API Keys** section for details.
19 * Start the search service if needed, see the **Search engine** section for details.
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
20
21
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
22 Development
23 -----------
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
24
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
25 To run Calagator in `development` mode, which automatically reloads code as you change it:
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
26
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
27 * Follow the **Setup** instructions above.
f4952f3 @igal Update INSTALL.md to use 'bundle exec rake'
igal authored May 27, 2011
28 * Initialize your database, run `bundle exec rake db:migrate db:test:prepare`
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
29 * Start the *Ruby on Rails* web application by running `./script/server` (UNIX) or `ruby script/server` (Windows).
30 * Open a web browser to <http://localhost:3000/> to use the development server
31 * Read the [Rails Guides](http://guides.rubyonrails.org/) to learn how to develop a Ruby on Rails application.
32 * When done, stop the *Ruby on Rails* server `script/server` by pressing `CTRL-C`.
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
33
34
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
35 Production
36 ----------
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
37
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
38 To run Calagator in `production` mode, which runs more quickly, but doesn't reload code:
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
39
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
40 * Follow the **Setup** instructions above. Don't forget to do things like create the theme and secrets files.
0f36b5e @igal Add instructions for firewalling search engine ports.
igal authored Jun 4, 2011
41 * Setup a firewall to protect ports used by your search engine, see the **Search engine** section for details.
f4952f3 @igal Update INSTALL.md to use 'bundle exec rake'
igal authored May 27, 2011
42 * Initialize your database, run `bundle exec rake RAILS_ENV=production db:migrate`
43 * Run `bundle exec rake clear` to clear your cache after updating your application's code.
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
44 * Setup a production web server using [Phusion Passenger](http://www.modrails.com/), [Thin](http://code.macournoyer.com/thin/), [Rainbows](http://rainbows.rubyforge.org/), etc. These will be able to serve more users more quickly than `script/server`.
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
45
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
46 The Calagator.org site runs on [Ubuntu Linux](http://ubuntu.com/), [Phusion REE (Ruby Enterprise Edition)](http://rubyenterpriseedition.com/) and [Phusion Passenger](http://www.modrails.com/).
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
47
48
49 Customization
50 -------------
51
52 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.
53
54
cf26725 @igal Updated CHANGES for v0.20091223.
igal authored Dec 24, 2009
55 Security and secrets.yml
56 ------------------------
8ac8588 @igal Created new README.md (about the project), INSTALL.md (how to install…
igal authored Sep 14, 2009
57
58 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](config/secrets.yml.sample) file for details.
59
60
f575b28 @igal Improved INSTALL.md to describe API keys used by app.
igal authored Dec 12, 2009
61 API Keys
62 --------
63
64 The application uses a number of API keys to communicate with external services.
65
265d0ae @igal Updated documentation to require Ruby on Rails 2.3.5.
igal authored May 4, 2010
66 * 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.
f575b28 @igal Improved INSTALL.md to describe API keys used by app.
igal authored Dec 12, 2009
67
7173790 @igal Revert "Remove need for a Google geocoder key."
igal authored Jun 7, 2011
68 * Google Maps: To display Google maps, you must get an API key. For details, see the `config/geocoder_api_keys.yml.example` for details.
69
f575b28 @igal Improved INSTALL.md to describe API keys used by app.
igal authored Dec 12, 2009
70
b2ca137 @igal Updated INSTALL instructions for specifying and using search engines.
igal authored Feb 7, 2011
71 Search engine
72 -------------
73
74 You can specify the search engine to use in your `config/secrets.yml` file:
75
76 ### sql
77
78 Default search engine which uses SQL queries. Requires no additional setup, dependencies or service. Does not provide relevance-based sorting. Provides substring matches.
79
80 ### sunspot
81
82 Optional search engine that uses the Sunspot gem. Requires additional setup, dependencies and service. Provides relevance-based sorting. Does not provide substring matches.
83
84 To use, you will need to [install Java 1.6.x](http://www.java.com/getjava), a programming language used to run the search service.
85
86 You will then need to initially populate your records by running commands like:
87
f4952f3 @igal Update INSTALL.md to use 'bundle exec rake'
igal authored May 27, 2011
88 bundle exec rake RAILS_ENV=production sunspot:solr:start
89 bundle exec rake RAILS_ENV=production sunspot:reindex:calagator
b2ca137 @igal Updated INSTALL instructions for specifying and using search engines.
igal authored Feb 7, 2011
90
91 You can start the Solr search service a command like:
92
f4952f3 @igal Update INSTALL.md to use 'bundle exec rake'
igal authored May 27, 2011
93 bundle exec rake RAILS_ENV=production sunspot:solr:start
b2ca137 @igal Updated INSTALL instructions for specifying and using search engines.
igal authored Feb 7, 2011
94
95 You can stop the Solr search service a command like:
96
f4952f3 @igal Update INSTALL.md to use 'bundle exec rake'
igal authored May 27, 2011
97 bundle exec rake RAILS_ENV=production sunspot:solr:stop
b2ca137 @igal Updated INSTALL instructions for specifying and using search engines.
igal authored Feb 7, 2011
98
0f36b5e @igal Add instructions for firewalling search engine ports.
igal authored Jun 4, 2011
99 You should setup a firewall to protect the ports that the Solr search service runs on. These ports are described in the `config/sunspot.yml` file.
100
b2ca137 @igal Updated INSTALL instructions for specifying and using search engines.
igal authored Feb 7, 2011
101 ### acts_as_solr
102
103 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.
104
105 To use, you will need to [install Java 1.6.x](http://www.java.com/getjava), a programming language used to run the search service.
106
107 You will then need to initially populate your records by running a command like:
108
f4952f3 @igal Update INSTALL.md to use 'bundle exec rake'
igal authored May 27, 2011
109 bundle exec rake RAILS_ENV=production solr:rebuild_index
b2ca137 @igal Updated INSTALL instructions for specifying and using search engines.
igal authored Feb 7, 2011
110
111 You can start the Solr search service a command like:
112
f4952f3 @igal Update INSTALL.md to use 'bundle exec rake'
igal authored May 27, 2011
113 bundle exec rake RAILS_ENV=production solr:start
b2ca137 @igal Updated INSTALL instructions for specifying and using search engines.
igal authored Feb 7, 2011
114
115 You can stop the Solr search service a command like:
116
f4952f3 @igal Update INSTALL.md to use 'bundle exec rake'
igal authored May 27, 2011
117 bundle exec rake RAILS_ENV=production solr:stop
b2ca137 @igal Updated INSTALL instructions for specifying and using search engines.
igal authored Feb 7, 2011
118
0f36b5e @igal Add instructions for firewalling search engine ports.
igal authored Jun 4, 2011
119 You should setup a firewall to protect the ports that the Solr search service runs on. These ports are described in the `config/solr.yml` file.
b2ca137 @igal Updated INSTALL instructions for specifying and using search engines.
igal authored Feb 7, 2011
120
45b14c5 @igal Improve INSTALL.md to describe some production server setup steps.
igal authored May 23, 2011
121 Feedback wanted
122 ---------------
123
3e2d450 @igal Update INSTALL.md to explain bundler usage, along with other improvem…
igal authored May 24, 2011
124 Is there something wrong, unclear or outdated in this documentation? Please get in touch so we can make it better. If you can contribute improved text, we'd really appreciate it.
Something went wrong with that request. Please try again.