src/product/ex.hg.conf 1.25

Index: src/product/ex.hg.conf
===================================================================
RCS file: /projects/compbio/cvsroot/kent/src/product/ex.hg.conf,v
retrieving revision 1.24
retrieving revision 1.25
diff -b -B -U 4 -r1.24 -r1.25
--- src/product/ex.hg.conf	5 May 2010 16:23:45 -0000	1.24
+++ src/product/ex.hg.conf	14 May 2010 19:44:00 -0000	1.25
@@ -38,19 +38,19 @@
 # implies a parallel hgFindSpec format search table exists in the form
 # hgFindSpec_suffix.  The specified trackDb tables are searched in the order
 # specified, with the first occurance of a track being used.  You may associate
 # trackDb/hgFindSpec tables with other instances of genome databases using a
-# specification of profile:trackDbTbl, where profile is the name of a
+# specification of dbProfile:trackDbTbl, where dbProfile is the name of a
 # databases profile in hg.conf, and trackDbTbl is the name of the table in the
-# remote databases.
+# remote databases.  See below for details of dbProfile
 # 
 db.trackDb=trackDb
 #db.trackDb=trackDb_local,trackDb
 #db.trackDb=trackDb,remoteDbs:trackDb
 
 # track group table definitions.  This is a comma-seperate list similar to
 # db.trackDb that defines the track group tables.  Database profiles 
-# may alow be included using the syntax profile:grpTbl.
+# may alow be included using the syntax dbProfile:grpTbl.
 db.grp=grp
 #db.grp=grp_local,grp
 #db.grp=grp,remoteDbs:grp
 
@@ -214,4 +214,56 @@
 # enable http(s) proxy support in net.c
 #httpProxy=http://someProxyServer:443/
 # if proxy server needs BASIC authentication
 #httpProxy=http://user:password@someProxyServer:443/
+
+##
+# Database profiles
+##
+#   The dbProfile facility provides a limited mechanism for access tracks from
+# multiple database servers.  This is particularly useful when a mirror server
+# contains the majority of the track data needs to be shared by multiple
+# groups with a small number of locally produced tracks that they the need to
+# keep isolated from the other groups.  A dbProfile associates a MySQL host,
+# user, and password with a dbProfile name.  To define a dbProfile named
+# myProfile, define the hg.conf variables:
+#
+#    myProfile.host
+#    myProfile.user
+#    myProfile.host
+#
+# The default profile is named `db', and is defined by the `db.*' variables
+# described above.  The `customTracks.*' and `central.*' variables also define
+# profiles.
+#
+# Profiles can be associated with an entire genome databases or some types of
+# tables.  To associated with a database, myGenome with myProfile, define the
+# variable:
+#     myGenome.profile=myProfile
+#
+# A dbProfile maybe associated with a trackDb/hgFindSpec table pair or a grp
+# table as described in the `db.trackDb' and `db.grp' variables above.  To
+# associate a particular track table, specify the "dbProfile" setting in the
+# trackDb entry:
+#
+#    track myTrack
+#    ...
+#    dbProfile myProfile
+#
+# Note that dbProfile only works on a small number of track types and is not
+# well tested.  In general, the dbProfile facility has not been widely use and
+# may still contain bugs.  The recommended approach for setting up a
+# remote/local server pair is to use the default profile for the remote server
+# with the majority of tracks, and use a non-default profile for local tracks
+# and trackDb tables.  A common configuration would be:
+
+#db.host=oursharedhost
+#db.user=readonly
+#db.password=access
+#
+#myStuff.host=localhost
+#myStuff.user=readonly
+#myStuff.password=access
+#
+#db.trackDb=myStuff:trackDb,trackDb
+#db.grp=myStuffgrp,grp
+#