Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.74 KB

application_setup.md

File metadata and controls

60 lines (38 loc) · 2.74 KB
Raw

Application Setup

Instructions are for any *nix type system. Commands are to be run from a terminal window (e.g., a bash shell in Terminal or iTerm), or in a similar shell in Linux or FreeBSD. Unless otherwise specified, commands are to be run from the project directory, once it has been cloned. The steps should be taken in order.

Production installation steps for Apache are listed with "For Apache installs only." These are not relevant in non-production environments (e.g., development and test), and must be modified for the target web server if passenger and Apache are not used.

It is highly suggested that you Setup the RAILS_ENV environment variable or anytime you are not working in "development" you will need to prefix any rails/rake/thor commands with e.g., "RAILS_ENV=production "

Now follow these steps in order:

  • System Setup This includes system libraries, rvm, ruby, and an application gemset.

  • Obtaining the Code

  • Internationalization Configure the display names for the participation category names and the application's User-Agent name. Optional for English-language installations.

  • Run the Thor task to generate new application secrets. It should be done at least once for a new install, and at any time later desired. If it is done later, it will require a server reboot to pick up the new values.

    thor keys:app_new_secret
    bundle install
  • For Apache installs only. Compile passenger module This step must be taken once on first install, and any time the passenger gem version changes.
    passenger-install-apache2-module

  • Configure the Engagement Index Scoring Values This step is optional, if the existing values are not desired. Random values are generated for the scoring items.

  • Assets (e.g., JavaScripts, CSS files, images) should be precompiled to run the app:

    rake assets:precompile
  • For Apache installs only. If you configuration requires, copy the assets into the $DOCROOT (where $DOCROOT is the base directory for the application for Apache to server static assets)
    cp -R public/assets/ $DOCROOT/
  • For apache installs only. Start or restart Apache. For example, one of the below:
   apachectl -k restart

   apachectl -k start