r4558 - in trunk/docs/user: . images
daigle at ecoinformatics.org
daigle at ecoinformatics.org
Wed Nov 12 16:50:12 PST 2008
Author: daigle
Date: 2008-11-12 16:50:11 -0800 (Wed, 12 Nov 2008)
New Revision: 4558
Modified:
trunk/docs/user/common.css
trunk/docs/user/default.css
trunk/docs/user/images/main-config.png
trunk/docs/user/metacatconfigure.html
Log:
Add instructions for configuring metacat ldap.
Modified: trunk/docs/user/common.css
===================================================================
--- trunk/docs/user/common.css 2008-11-12 18:33:25 UTC (rev 4557)
+++ trunk/docs/user/common.css 2008-11-13 00:50:11 UTC (rev 4558)
@@ -49,7 +49,6 @@
font-weight: bold;
margin-left: 0.25em;
margin-top: .5em;
- padding-top: 1em;
}
.header3 {
/* font-size: 1em; */
@@ -97,3 +96,14 @@
.indent {
margin-left: 1em;
}
+img.screenshot {
+ display: block;
+ margin-top: 10px;
+ margin-left: auto;
+ margin-right: auto;
+}
+.fig-text {
+ margin-top: 10px;
+ width: 100%;
+ text-align: center;
+}
\ No newline at end of file
Modified: trunk/docs/user/default.css
===================================================================
--- trunk/docs/user/default.css 2008-11-12 18:33:25 UTC (rev 4557)
+++ trunk/docs/user/default.css 2008-11-13 00:50:11 UTC (rev 4558)
@@ -170,10 +170,6 @@
padding: 0.25em;
border: none;
float: left; }
-img.screenshot {
- display: block;
- margin-left: auto;
- margin-right: auto; }
.roweven {
background: #c0d3e7; }
.rowodd {
Modified: trunk/docs/user/images/main-config.png
===================================================================
(Binary files differ)
Modified: trunk/docs/user/metacatconfigure.html
===================================================================
--- trunk/docs/user/metacatconfigure.html 2008-11-12 18:33:25 UTC (rev 4557)
+++ trunk/docs/user/metacatconfigure.html 2008-11-13 00:50:11 UTC (rev 4558)
@@ -17,6 +17,7 @@
<head>
<title>Metacat Configuration Instructions</title>
+ <link rel="stylesheet" type="text/css" href="./common.css">
<link rel="stylesheet" type="text/css" href="./default.css">
</head>
@@ -40,57 +41,48 @@
</table>
<hr>
-<table class="tabledefault" width="100%">
-<td class="tablehead" colspan="2"><p><a name="The Table of Contents"><h2>The Table of Contents</h2></p></td>
-<tr>
-<td>
- <ul>
- <li>
- <a HREF="metacatconfigure.html#introduction">Introduction</a>
- </li>
- <li>
- <a HREF="metacatconfigure.html#ldap-config">LDAP Configuration</a>
- </li>
- <li>
- <a HREF="metacatconfigure.html#admin-login">Admin Log In</a>
- </li>
- <li>
- <a HREF="metacatconfigure.html#main-config">Main Configuration Page</a>
- </li>
- <li>
- <a HREF="metacatconfigure.html#properties-config">Main Properties Configuration</a>
- </li>
- <li>
- <a HREF="metacatconfigure.html#database-config">Database Configuration</a>
- </li>
- </ul>
-</td>
-</tr>
-</table>
+<div class="header1">Table of Contents</div>
+<div class="toc">
+ <div class="toc1"><a href="#Overview">Overview</a></div>
+ <div class="toc2"><a href="#MetacatConfiguration">Metacat Configuration</a></div>
+ <div class="toc2"><a href="#ConfigurationRules">Configuration Rules</a></div>
+ <div class="toc1"><a href="#LdapConfig">LDAP Configuration</a></div>
+ <div class="toc2"><a href="#LdapOverview">LDAP Overview</a></div>
+ <div class="toc2"><a href="#GetToLdapConfig">Getting to the LDAP Configuration</a></div>
+ <div class="toc2"><a href="#ConfigLdapNoAuth">Changing LDAP Configuration Without Authentication</a></div>
+ <div class="toc1"><a href="#AdminLogin">Admin Log In</a></div>
+ <div class="toc1"><a href="#MainConfig">Main Configuration Page</a></div>
+ <div class="toc1"><a href="#PropertiesConfig">Main Properties Configuration</a></div>
+ <div class="toc1"><a href="#DatabaseConfig">Database Configuration</a></div>
+ <div class="toc1"><a href="#GeoserverConfig">Geoserver Configuration</a></div>
+</div>
-<table class="tabledefault" width="100%">
-<td class="tablehead" colspan="2"><p><a name="introduction"><h2>Introduction</h2></p></td>
-<tr>
-<td>
- <p>
- The first time you go to Metacat after installation or upgrade, you will be directed to
- a series of configuration screens. You can also get there explicitly even after Metacat
- is configured by typing:
-
- <pre>
- http://<yourserver.yourdomain.com>/<yourcontext>/admin
- </pre>
- or if you are not running apache:
- <pre>
- http://<yourserver.yourdomain.com>:8080/<yourcontext>/admin
- </pre>
- </p>
-
- <p>
- The system will follow these rules in order to determine the order
- that the configuration will occur:
- </p>
+<a name="Overview"></a><div class="header1">Overview</div>
+<a name="MetacatConfiguration"></a><div class="header2">Metacat Configuration</div>
+ <p>As of version 1.9.0, Metacat configuration is done internally by the application. When
+ Metacat (Tomcat) is started, it will check to see if it is configured. If not, you will be
+ automatically sent to the configuration pages. </p>
+ <p>If the installation is new, or the previous version is before 1.9.0, you will
+ need to pay close attention to the configuration values. If you have upgraded
+ Metacat, and the previous version is 1.9.0 or later, Metacat will pull existing
+ values from a backup location. You should still verify that the values are
+ correct.</p>
+
+ <p>Get to Metacat on your server by entering into the browser:</p>
+ <div class="code">http://<your_context_url></div>
+ <p>Where <your_context_url> is the url where Metacat will be served followed
+ by the name of the war file(application context) that you installed. For instance,
+ the KNB production Metacat url is:</p>
+ <div class="code">http://knb.ecoinformatics.org/knb</div>
+
+ <p>You can always go to the configuration screen from within Metacat by typing:
+ <div class="code"><your_context_url>/admin</div>
+
+<a name="ConfigurationRules"></a><div class="header2">Configuration Rules</div>
+ <p>The system will follow these rules in order to determine the order
+ that the configuration will occur:</p>
+
<ul>
<li>
Is LDAP Configured? If not, show
@@ -104,32 +96,68 @@
You can only configure Metacat as an administrator.
</li>
<li>
- Are main properties, skins or database unconfigured. If so, show
+ Are main properties, skins or database unconfigured? If so, show
<a HREF="metacatconfigure.html#main-config">Main Configuration Page</a>
- <ul>
- <li>
- Note that you will not be able to select the database configuration utility
- until main properties have been configured.
- </li>
- </ul>
+ Note that you will not be able to select the database configuration utility
+ until main properties have been configured.
+ </li>
<li>
- Are all sections configured. If so, show
- <a HREF="metacatconfigure.html#main-config">Main Configuration Page</a> but
- Include instructions for restarting Metacat server.
+ Are all sections configured? If so, show
+ <a HREF="metacatconfigure.html#main-config">Main Configuration Page</a> which
+ include instructions for going to Metacat server (or restarting Metacat if you
+ are reconfiguring a running server).
</li>
- </li>
</ul>
<p> See the following sections for descriptions of how each of these work.</p>
-</td>
-</tr>
-</table>
-<table class="tabledefault" width="100%">
-<td class="tablehead" colspan="2"><p><a name="ldap-config"><h2>LDAP Configuration</h2></p></td>
-<tr>
-<td>
+<a name="LdapConfig"></a><div class="header1">LDAP Configuration</div>
+<a name="LdapOverview"></a><div class="header2">Overview</div>
+ <p>Metacat uses LDAP as it's primary authentication mechanism. The three main
+ values needed are LDAP URL, LDAP Secure URL and Metacat Administrators. You need
+ to verify that the the LDAP URL and LDAP Secure URL are correct (fig 1).
+ <span class="emphasis">You need to make sure that your LDAP user
+ account is entered into the MetaCat Administrators field. You will not be allowed
+ to continue with configuration if this is missing.</span>
+
<img class="screenshot" src="./images/ldap-config.png"/>
-</td>
-</tr>
-</table>
+ <div class="fig-text"> fig 1 </div>
+
+<a name="GetToLdapConfig"></a><div class="header2">Getting to the LDAP Configuration</div>
+ <p>You will automatically be sent to the LDAP Configuration page if this is a new
+ installation or upgrade.</p>
+
+ <p>You can also get to the LDAP configuration from a running Metacat by typing:</p>
+ <div class="code"><your_context_url>/admin</div>
+ <p>You will be required to log in as an administrator and restart Metacat once you
+ make changes.</p>
+
+ <a name="ConfigLdapNoAuth"></a><div class="header2">Changing LDAP Configuration Without Authentication</div>
+ <p>There is one exception to the log in rule. That is when you need to change or add
+ LDAP information, but you can't authenticate using the existing setup. For example:</p>
+
+ <ul>
+ <li>The existing Metacat administrator is no longer available</li>
+ <li>You forgot the administrator password.</li>
+ <li>The configured LDAP urls are unavailable and you need to configure new ones.</li>
+ </ul>
+
+ <p>In this case, you will need to edit the Metacat configuration file by hand and
+ make the changes. This insures that only a person who has access to the Metacat
+ server and the configuration files on that server will be able to change the
+ administrator accounts</p>
+
+ <p>Stop Tomcat and edit the Metacat properties file at:</p>
+ <div class="code"><webapp_dir>/<context_dir>/WEB-INF/metacat.properties</div>
+ <p>where <webapp_dir> is the place that Tomcat looks for applications and
+ <context_dir> is the name of the Metacat application (usually knb). Change the
+ following properties appropriately:</p>
+
+ <ul>
+ <li>ldap.administrators - a colon separated list of administrators</li>
+ <li>ldap.url - the LDAP server url</li>
+ <li>ldap.surl - the LDAP secure server url</li>
+ </ul>
+
+ <p>Save the metacat.properties file and start Tomcat.</p>
+
More information about the Metacat-cvs
mailing list