Umlaut Setup - Revision history

Jrochkind at 16:20, 19 June 2012

2012-06-19T16:20:54Z

Navtis: /* 7. Nightly maintenance */

2010-02-09T11:36:10Z

‎7. Nightly maintenance

Navtis: /* 1. Create Local Config Directories */

2010-02-08T16:45:52Z

‎1. Create Local Config Directories

173.67.52.6: /* 2. Configure your database connection information */

2010-02-08T14:23:45Z

‎2. Configure your database connection information

96.234.232.57: /* 5. Set up your Institutions and Services */

2009-06-09T05:41:31Z

‎5. Set up your Institutions and Services

128.220.205.186: /* Next Steps? */

2008-11-26T20:16:07Z

‎Next Steps?

128.220.205.186: /* Next Steps? */

2008-11-26T20:15:22Z

‎Next Steps?

128.220.205.186: /* Next Steps? */

2008-11-26T20:14:48Z

‎Next Steps?

128.220.205.186: /* 6. Review additional local configuration */

2008-11-26T20:12:13Z

‎6. Review additional local configuration

128.220.205.186: /* 5. Set up your Institutions and Services */

2008-11-26T20:11:46Z

‎5. Set up your Institutions and Services

← Older revision		Revision as of 16:20, 19 June 2012
Line 1:		Line 1:
	[[Category:Umlaut]]		[[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 =		= Umlaut First-Time Setup and Configuration =

@@ Line 79: / Line 79: @@
 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)
+: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):

← Older revision		Revision as of 16:45, 8 February 2010
Line 15:		Line 15:
	This will create several directories including the one we care about now: $Umlaut/config/umlaut_config/		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

@@ Line 27: / Line 27: @@
 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 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.
+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 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.

← Older revision		Revision as of 05:41, 9 June 2009
Line 62:		Line 62:

	Note: The A-Z list and journal name lookup will only currently work if using the direct connection to the SFX database.		Note: The A-Z list and journal name lookup will only currently work if using the direct connection to the SFX database.
−
−
−	After editing the institutions.yml file, it needs to be synced with the db, as some institution information is stored in the db. Umlaut should check on startup if timestamp of institutions.yml requires a resync and do it automatically, but if you want to do it manually you can cd into the $UMLAUT directory and run:
−
−	~~:rake umlaut:sync_institutions (RAILS_ENV=production)~~

	== 6. Review additional local configuration ==		== 6. Review additional local configuration ==

@@ Line 106: / Line 106: @@
   http://yourservername.tld:3000/search
 This is a fine way to start it just for testing, but to deploy it for real see [[Umlaut Deployment]].
 You may also be interested in providing your own customized header, footer, or stylesheets. For this, and more localization, you'll find it helpful to see [[Umlaut Local Configuration Architecture]].

@@ Line 97: / Line 97: @@
 To try out Umlaut, cd into the $Umlaut directory and run "./script/server"  to launch the Rails app. (Be sure you've installed mongrel with 'sudo gem install mongrel', in which case Umlaut will be started with the mongrel environment. The default WEBrick environment will not work for Umlaut!). You'll then connect to Umlaut on
-:http://yourservername.tld:3000
+ http://yourservername.tld:3000
 The resolver base URL will be:
-:http://yourservername.tld:3000/resolve?.
+ http://yourservername.tld:3000/resolve?.
 The A-Z search interface will be:
-:http://yourservername.tld:3000/search
+ http://yourservername.tld:3000/search
 This is a fine way to start it just for testing, but to deploy it for real see [[Umlaut Deployment]].
 You may also be interested in providing your own customized header, footer, or stylesheets. For this, and more localization, you'll find it helpful to see [[Umlaut Local Configuration Architecture]].

@@ Line 72: / Line 72: @@
 There are several files in $Umlaut/config/umlaut_config/initializers/umlaut that contain additional local configuration parameters. A bunch of examples are provided for you, you'll have to un-comment the line and set a value if you want to locally configure a particular property.
-There are only a few that are really best set right away, all in umlaut_config/initializers/umlaut_properties.rb
+There are only a few that are really best set right away, all in umlaut_config/initializers/umlaut/umlaut_properties.rb
 * You may want to set your local application name and a URL to an image for a 'link resolver button'. The button is mainly only used in Umlaut 'search' functionality (look up a manually typed in citation or journal name).
 * You will definitely need to point AppConfig::Base.main_sfx_base_url to your SFX base URL. This is not used in general link resolver menu functions, but may be used in 'search' function to look up a manually typed in journal name or citation. It is also used on Umlaut's error page, to give the user an option of going to the native original SFX in an error condition.

← Older revision		Revision as of 20:11, 26 November 2008
Line 64:		Line 64:


−	After editing the institutions.yml file, it needs to be synced with the db, as some institution information is stored in the db. Umlaut should check on startup if timestamp of institutions.yml requires a resync and do it automatically, but if you want to do it manually you can ~~run~~ cd into the $UMLAUT directory and run:	+	After editing the institutions.yml file, it needs to be synced with the db, as some institution information is stored in the db. Umlaut should check on startup if timestamp of institutions.yml requires a resync and do it automatically, but if you want to do it manually you can cd into the $UMLAUT directory and run:

	:rake umlaut:sync_institutions (RAILS_ENV=production)		:rake umlaut:sync_institutions (RAILS_ENV=production)