Changes

Jump to: navigation, search

Umlaut Setup

304 bytes added, 16:20, 19 June 2012
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
---------
= Umlaut First-Time Setup and Configuration =
This will create several directories including the one we care about now: $Umlaut/config/umlaut_config/
Mysql by default has no password for the root user. If you have set a root password, you will need to add this to $Umlaut/config/database.yml
In Umlaut (a little bit different than standard Rails), your local connection information for your dbs is stored in $Umlaut/config/umlaut_config/database.yml. There should already be an example file there with some hints in it.
We reccommend MySQL 5.x for use with Umlaut. ( SQLite3 won't work, unless you figure out a way to compile it with concurrency support). Create your databases in MySQL. We recommend making sure they are set to UTF8 char encoding. (eg, (CREATE DATABASE 'Name' DATABASE my_db_name DEFAULT CHARACTER SET utf8). Don't create any tables in your databases yet, that will be done automatically. Do fill out your umlaut_config/database.yml file to point at the right place.
For search functions (manually entered journal name or citation), Umlaut uses a direct db connection to your SFX instance. You should use the MySQL utility to create a new user in the SFX MySQL instance, which is granted only select permissions to the SFX databases. Then, you can fill out your SFX direct to db connection information in config/umlaut_config/database.yml.
Some maintenance routines meant to be run nightly can be executed by cd'ing to your $Umlaut directory and running:
:rake umlaut:nightly_maintenance (RAILS_ENV=production)
To put that in a cron job, use this (with parens, where $Umlaut represents your umlaut install directory as usual):

Navigation menu