[MOBY-guts] biomoby commit

[Andreas Groscurth]

groscurt
Wed Nov 19 11:34:15 EST 2008
Update of /home/repository/moby/moby-live/Java/docs
In directory dev.open-bio.org:/tmp/cvs-serv10445/Java/docs

Modified Files:
	Dashboard.html 
Log Message:
added information about the changes in the dashboard.properties file and how to add new repositories

moby-live/Java/docs Dashboard.html,1.8,1.9
===================================================================
RCS file: /home/repository/moby/moby-live/Java/docs/Dashboard.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- /home/repository/moby/moby-live/Java/docs/Dashboard.html	2008/02/14 06:13:34	1.8
+++ /home/repository/moby/moby-live/Java/docs/Dashboard.html	2008/11/19 16:34:15	1.9
@@ -29,6 +29,7 @@
    <li> <a href="#howtostart">How to start Dashboard</a>
    <li> <a href="#howtostart">How to use Dashboard</a>
    <li> <a href="#panels">Dashboard Panels Gallery</a>
+   <li> <a href="#repos">Customize the available repositories / Adding a new Repository</a>
    <li> <a href="#todos">Plans and issues</a>
    <li> <a href="Dashboard-dev.html">Dashboard for developers</a>
 	<ul>
@@ -225,6 +226,33 @@
 </table>
 <p>
 
+<a name="repos"></a>
+<h2>Customize the available repositories / Adding a new Repository</h2>
+This explains how you can manipulate the available repositories in your Dashboard.
+<h3>Customize the available repositories</h3>
+To manipulate which repositories shall be available in your Dashboard application you can edit the <i>moby-live/Java/src/config/dashboard/dashboard.properties</i> file.<br>
+Search for the <i>dashboard.wanted.registries</i>, which is per default not active. If you activate it by removing the # before the line you can remove the repositories by deleting the corresponding entry.<br>
+For example this is the original one:
+<blockquote>
+<pre class="script">
+#dashboard.wanted.registries = default,Calgary,INB,IRRI,testing
+</pre>
+</blockquote>
+if you now want only to have the official BioMoby central and its test repository:
+<blockquote>
+<pre class="script">
+dashboard.wanted.registries = default,Calgary,testing
+</pre>
+</blockquote>
+after that just start dashboard again with <i>ant dashboard</i>
+
+<h3>Adding a new Repository</h3>
+<p><b>IMPORTANT: We do not encourage people to set up their own repository as every can use the official BioMoby central repository. But if in any case you have to set up an own repository this explains how to make it visible in Dashboard.</b></p>
+The easiest way is to type the URL and the URI in the <i>Endpoint</i> and <i>Namespace (URI)</i> input fields in Dashboard, respectively. Dashboard does remember your inputs and you can select your entries later again.
+<p>If you want to have it as an entry in the dropdown box you have to edit the <i>moby-live/Java/src/org/biomoby/registry/meta/RegistriesList.java</i> file and add there your repository based on the template of the others. <b>This should be only done if you know what you are doing !</b><br>
+After that you should add the name of your repository also to the <i>dashboard.wanted.registries</i> property inside the <i>moby-live/Java/src/config/dashboard/dashboard.properties</i>.<br></p>
+If you then restart dashboard you will see now your repository coming up.
+
 <a name="todos"></a>
 <h2>Plans and issues</h2>