Difference between revisions of "Umlaut Installation"

Revision as of 19:42, 9 April 2008

To install Umlaut

1. Make sure you have a modern Ruby

Rails recommends Ruby 1.8.4 (and requires at least 1.8.2, but 1.8.3 is incompatible). Some Red Hat versions may come with only 1.8.1. Try installing Ruby with your package manager of choice, and see if you can get 1.8.4. If not, try installing from source:

1. [Download 1.8.4>http://rubyforge.org/frs/download.php/7858/ruby-1.8.4.tar.gz]
2. tar -zxvf ruby-1.8.4.tar.gz
3. cd ruby-1.8.4
4. sudo ./configure
5. sudo make
6. sudo make install

2. Install RubyGems

Again, your package manager may be able to supply this (for example "yum install rubygems), but if not, you could again install from source:

1. [Download here>http://rubyforge.org/frs/?group_id=126]
2. tar -zxvf rubygems-x.x.x.tar.gz
3. cd rubygems-x.x.x
4. sudo ruby setup.rb

( actually don't do this, to be safe # sudo gem update)

[NOTE: Right now, umlaut may only work with rubygems 0.9. Working on it!]

3. Install Rails

Umlaut is currently tested with Rails 1.2.1, and bound to it in the default environment.rb. So install the 1.2.1 version of Rails (you can have multiple versions of Rails installed simulataneously, don't worry about this overwriting a more recent version of Rails you may want--it won't.0

"sudo gem install rails -v 1.2.1" (say yes to any dependencies)

You could change the environment.rb to accept a more recent version, but don't accidentally commit that! At some point, we should test and ensure it with a more recent version (2.x?), and bump it up.

Note: There are various guides available on the net to getting Ruby/Rubygems/Rails installed on various OSs. Consult if you have trouble.

4. Install Umlaut

Right now, the best (only) way to install Umlaut is from it's SVN store.

For a read-only checkout:

svn checkout http://umlaut.rubyforge.org/svn/U2/ ./Umlaut

For a checkout with commit privs, you need a rubyforge account and to be added to the umlaut project, then:

svn checkout svn+ssh://(developername)@rubyforge.org/var/svn/umlaut/U2 ./Umlaut

Umlaut comes with a number of Ruby gems and Rails plugins "frozen" into it's distribution, in vendor/plugins. You do not need to install these, they come with Umlaut. These include: ferret; oai; ruby-json; sru; xisbn; acts_as_ferret; enumerations_mixin ; app_config (plugin); isbn-tools (plugin) ; openurl ( svn external link in plugin; needs to be fixed to link to a specific tag ); htmlentities http://htmlentities.rubyforge.org/

However, there are a few plugins that can not be conveniently packaged with Umlaut, you need to install them yourself...

5. Install Umlaut's gem dependencies

mongrel

(Umlaut will not run with WEBrick due to threading issues. Recommend installing mongrel for testing and deployment. )

sudo gem install mongrel

hpricot

(hpricot is compiled C code, so you are best off installing it yourself)

sudo gem install hpricot

mysql

(not neccesarily required, but mysql is the reccomended db. Umlaut won't usually run with SQLite3 due to threading issues.)

sudo gem install msyql

More optional gems

• If you have a google API key and want to use google services, you may want Ruby/Google
• There are some untested services that use Connotea and require ConnoteaRuby, although Umlaut at present does not have stable Connotea integration.
• Voyager sites that want to bypass z39.50 and access Oracle directly will need Oracle Instant Client or Full Client installed on the same machine as the Umlaut.Oracle OCI8 Oracle Instant Client

Now You Need to Setup Umlaut

Good job, you've got all software installed, now you need to do some setup. See Umlaut Setup.