Configuring and Preparing GUS

Once you have downloaded and expanded the GUS distribution, you must configure your environment. These settings are required for all uses of GUS, and as such is it highly recommended that you add them in such a manner that they be set upon creating a new session (i.e. in your .bash_profile file). The following examples are for the Bash shell, and assume you have expanded the GUS distribution in the directory /home/smith:

Example 2.1. Configuring the Environment for GUS

$ export GUS_HOME=/home/smith/GUS/gus_home
$ export PROJECT_HOME=/home/smith/GUS/project_home
$ export GUS_CONFIG_FILE=/home/smith/GUS/gus.properties 
$ export PERL5LIB=$GUS_HOME/lib/perl
$ export PATH=$GUS_HOME/bin:$PROJECT_HOME/install/bin:$PATH

Note

Throughout the rest of this document, $GUS_HOME, $PROJECT_HOME, and $GUS_CONFIG_FILE will frequently be used to refer to the locations specified above.

After your environment has been configured for GUS, you must configure the GUS software itself. First, copy the $PROJECT_HOME/install/gus.config.sample file to $PROJECT_HOME/install/gus.config. Once copied, you must open this file and provide the necessary values:

Example 2.2. Configuring gus.config file

dbVendor=Oracle_or_Postgres1
dbiDsn=perl_dbi_string2
jdbcDsn=jdbc_conection_string
databaseLogin=database_username3
databasePassword=database_password
userName=gus_username4
group=gus_group
project=primary_gus_project
perl=path_to_perl_binary5
md5sum=path_to_md5_or_md5sum_binary6
1

The database system you are using. This must be either Oracle or Postgres.

2

dbiDsn is the Perl DBI string for your database. For example, dbi:Oracle:mygus.

jdbcDsn is the JDBC string for your database. For example, jdbc:oracle:thin:@myserver:1521:mygus.

3

databaseLogin and databasePassword are the username and password that the software will use to connect to your database.

4

username, group, and project are used within the GUS system for auditing and permissions purposes. For now, use dba as the userName and group and Database administration as the project. See the GUS User's Guide for more information about these settings.

5

perl is the full path to your Perl executable.

6

md5sum is the full path to your md5sum or md5 executable.

Caution

Since GUS 3.5 the gus.properties, install.prop, schema.prop and other various configuration files are automatically created using the values specified in the gus.config file. All of these files, except the gus.properties file, will be overwritten by the GUS installer whenever it us run. The gus.properties file will never be overwritten by the GUS installer. Care should be taken to understand at all times what values are specified in the gus.properties file as it determines the database the GUS system will access.