200
edits
Changes
no edit summary
[[Category:Umlaut]]
=WARNING: This is Outdated Documentation!!!!=
'''THIS IS OUTDATED DOCUMENTATION''' See new Umlaut documentation at http://github.com/team-umlaut/umlaut/wiki
---------
To install Umlaut
== 1. Make sure you have a modern Ruby ==
Install a 1.8.x version of ruby, ruby 1.9 is still considered experimental. The Rails recommends web page says "We recommend Ruby 1.8.7 for use with Rails. Ruby 1.8.6, 1.8.5, 1.8.4 (and requires at least 1.8.2are still usable too, but version 1.8.3 is incompatible)not. Some Red Hat versions may come with only "The ''marc'' gem (referred to below) needs Ruby 1.8.16 or greater to install. (http://rubyonrails.org/download) Try installing Ruby with your package manager of choice, and see if you can get 1.8.4. If not, try installing from source:, eg
# [Download 1.8.4>http://rubyforge.org/frs/download.php/7858/ruby-1.8.47.tar.gz]# tar -zxvf ruby-1.8.47.tar.gz# cd ruby-1.8.47
# sudo ./configure
# sudo make
# sudo make install
( jrochkind is currently running ruby 1.8.6 as of Dec 08 )
== 2. Install RubyGems ==
# cd rubygems-x.x.x
# sudo ruby setup.rb
( actually don't do this, to be safe # sudo gem update) [NOTE: Right now(I don't know what this means, umlaut may only work with rubygems 0.9. Working on itjrochkind 14 May 09!])
== 3. Install Rails ==
Umlaut is currently tested with requires Rails 1.2.1.2, and is bound to it in the default environment.rb. It has not been verified for Rails 2.2.x yet. So install the 1.2.1 .2 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.2" (say yes to any dependencies)
'''Note''': There are various guides available on the net to getting Ruby/Rubygems/Rails installed on various OSs. Consult if you have trouble.
Right now, the best (only) way to install Umlaut is from it's SVN store.
For a read-only checkoutof Umlaut 2.10.0 (If there is a more recent version, hopefully I'll remember to update it here, or ask me, or look around in the svn repo. 1 July 09):
<pre>svn checkout http://umlaut.rubyforge.org/svn/U2tags/ 2.10.0 ./Umlaut</pre> Or instead of "./Umlaut", whatever local path you want to put the thing in.
For a checkout with commit privs, you need a rubyforge account and to be added to the umlaut project, then:
<pre>svn checkout svn+ssh://(developername)@rubyforge.org/var/svn/umlaut/U2 tags/2.10.0 ./Umlaut</pre>
If you are a developer who wants the latest in-progress version of umlaut, check out /trunk instead of /tags/2.10.0. 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-jsonjson_pure ; sru; xisbn; acts_as_ferret; enumerations_mixin (plugin) ; 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...
sudo gem install hpricot -v 0.6
=== json ===
A pure-ruby json library is bundled with Umlaut automatically, but you really ought to install the compiled C one on your server instead, for much better performance. Umlaut will automatically use it if present. Currently verified with version 1.1.3
sudo gem install json -v 1.1.3
=== marc ===
A rubygem necessary for the generate script. Provides a ruby library for processing Machine Readable Cataloging (MARC) bibliographic data.
sudo gem install marc
=== mysql ===
sudo gem install msyql
Except some additional configuration arguments may be neccesary to compile on your machine.
===== redhat =====
On RedHat and CentOS machines, you will need to have the mysql-devel packages installed.
On a RedHat machine, this works:
sudo gem install mysql -- --with-mysql-config=/usr/lib/mysql/mysql_config
===== ubuntu =====
On Ubuntu you will also need to:
sudo apt-get install libmysqlclient15-dev
Then you can:
sudo gem install mysql
Ubuntu also packages the mysql library, if you'd rather use that version you can try:
sudo apt-get install libmysql-ruby
===== Solaris 10 (sparc) =====
This has been reported to work on Solaris 10 (sparc)
gem install mysql -- --with-mysql-include=/opt/pkgs/mysql/include/
\ --with-mysql-lib=/opt/pkgs/mysql/lib
=== More optional gems ===
== Now You Need to Setup Umlaut ==
Good job, you've got all software installed, now you need to do some setup. See [[Umlaut Setup]].