Revision 4558
Added by daigle about 16 years ago
metacatconfigure.html | ||
---|---|---|
17 | 17 |
|
18 | 18 |
<head> |
19 | 19 |
<title>Metacat Configuration Instructions</title> |
20 |
<link rel="stylesheet" type="text/css" href="./common.css"> |
|
20 | 21 |
<link rel="stylesheet" type="text/css" href="./default.css"> |
21 | 22 |
</head> |
22 | 23 |
|
... | ... | |
40 | 41 |
</table> |
41 | 42 |
<hr> |
42 | 43 |
|
43 |
<table class="tabledefault" width="100%"> |
|
44 |
<td class="tablehead" colspan="2"><p><a name="The Table of Contents"><h2>The Table of Contents</h2></p></td> |
|
45 |
<tr> |
|
46 |
<td> |
|
47 |
<ul> |
|
48 |
<li> |
|
49 |
<a HREF="metacatconfigure.html#introduction">Introduction</a> |
|
50 |
</li> |
|
51 |
<li> |
|
52 |
<a HREF="metacatconfigure.html#ldap-config">LDAP Configuration</a> |
|
53 |
</li> |
|
54 |
<li> |
|
55 |
<a HREF="metacatconfigure.html#admin-login">Admin Log In</a> |
|
56 |
</li> |
|
57 |
<li> |
|
58 |
<a HREF="metacatconfigure.html#main-config">Main Configuration Page</a> |
|
59 |
</li> |
|
60 |
<li> |
|
61 |
<a HREF="metacatconfigure.html#properties-config">Main Properties Configuration</a> |
|
62 |
</li> |
|
63 |
<li> |
|
64 |
<a HREF="metacatconfigure.html#database-config">Database Configuration</a> |
|
65 |
</li> |
|
66 |
</ul> |
|
67 |
</td> |
|
68 |
</tr> |
|
69 |
</table> |
|
44 |
<div class="header1">Table of Contents</div> |
|
45 |
<div class="toc"> |
|
46 |
<div class="toc1"><a href="#Overview">Overview</a></div> |
|
47 |
<div class="toc2"><a href="#MetacatConfiguration">Metacat Configuration</a></div> |
|
48 |
<div class="toc2"><a href="#ConfigurationRules">Configuration Rules</a></div> |
|
49 |
<div class="toc1"><a href="#LdapConfig">LDAP Configuration</a></div> |
|
50 |
<div class="toc2"><a href="#LdapOverview">LDAP Overview</a></div> |
|
51 |
<div class="toc2"><a href="#GetToLdapConfig">Getting to the LDAP Configuration</a></div> |
|
52 |
<div class="toc2"><a href="#ConfigLdapNoAuth">Changing LDAP Configuration Without Authentication</a></div> |
|
53 |
<div class="toc1"><a href="#AdminLogin">Admin Log In</a></div> |
|
54 |
<div class="toc1"><a href="#MainConfig">Main Configuration Page</a></div> |
|
55 |
<div class="toc1"><a href="#PropertiesConfig">Main Properties Configuration</a></div> |
|
56 |
<div class="toc1"><a href="#DatabaseConfig">Database Configuration</a></div> |
|
57 |
<div class="toc1"><a href="#GeoserverConfig">Geoserver Configuration</a></div> |
|
58 |
</div> |
|
70 | 59 |
|
71 |
<table class="tabledefault" width="100%"> |
|
72 |
<td class="tablehead" colspan="2"><p><a name="introduction"><h2>Introduction</h2></p></td> |
|
73 |
<tr> |
|
74 |
<td> |
|
75 |
<p> |
|
76 |
The first time you go to Metacat after installation or upgrade, you will be directed to |
|
77 |
a series of configuration screens. You can also get there explicitly even after Metacat |
|
78 |
is configured by typing: |
|
79 |
|
|
80 |
<pre> |
|
81 |
http://<yourserver.yourdomain.com>/<yourcontext>/admin |
|
82 |
</pre> |
|
83 |
or if you are not running apache: |
|
84 |
<pre> |
|
85 |
http://<yourserver.yourdomain.com>:8080/<yourcontext>/admin |
|
86 |
</pre> |
|
87 |
</p> |
|
88 |
|
|
89 |
<p> |
|
90 |
The system will follow these rules in order to determine the order |
|
91 |
that the configuration will occur: |
|
92 |
</p> |
|
60 |
<a name="Overview"></a><div class="header1">Overview</div> |
|
61 |
<a name="MetacatConfiguration"></a><div class="header2">Metacat Configuration</div> |
|
62 |
<p>As of version 1.9.0, Metacat configuration is done internally by the application. When |
|
63 |
Metacat (Tomcat) is started, it will check to see if it is configured. If not, you will be |
|
64 |
automatically sent to the configuration pages. </p> |
|
93 | 65 |
|
66 |
<p>If the installation is new, or the previous version is before 1.9.0, you will |
|
67 |
need to pay close attention to the configuration values. If you have upgraded |
|
68 |
Metacat, and the previous version is 1.9.0 or later, Metacat will pull existing |
|
69 |
values from a backup location. You should still verify that the values are |
|
70 |
correct.</p> |
|
71 |
|
|
72 |
<p>Get to Metacat on your server by entering into the browser:</p> |
|
73 |
<div class="code">http://<your_context_url></div> |
|
74 |
<p>Where <your_context_url> is the url where Metacat will be served followed |
|
75 |
by the name of the war file(application context) that you installed. For instance, |
|
76 |
the KNB production Metacat url is:</p> |
|
77 |
<div class="code">http://knb.ecoinformatics.org/knb</div> |
|
78 |
|
|
79 |
<p>You can always go to the configuration screen from within Metacat by typing: |
|
80 |
<div class="code"><your_context_url>/admin</div> |
|
81 |
|
|
82 |
<a name="ConfigurationRules"></a><div class="header2">Configuration Rules</div> |
|
83 |
<p>The system will follow these rules in order to determine the order |
|
84 |
that the configuration will occur:</p> |
|
85 |
|
|
94 | 86 |
<ul> |
95 | 87 |
<li> |
96 | 88 |
Is LDAP Configured? If not, show |
... | ... | |
104 | 96 |
You can only configure Metacat as an administrator. |
105 | 97 |
</li> |
106 | 98 |
<li> |
107 |
Are main properties, skins or database unconfigured. If so, show
|
|
99 |
Are main properties, skins or database unconfigured? If so, show
|
|
108 | 100 |
<a HREF="metacatconfigure.html#main-config">Main Configuration Page</a> |
109 |
<ul> |
|
110 |
<li> |
|
111 |
Note that you will not be able to select the database configuration utility |
|
112 |
until main properties have been configured. |
|
113 |
</li> |
|
114 |
</ul> |
|
101 |
Note that you will not be able to select the database configuration utility |
|
102 |
until main properties have been configured. |
|
103 |
</li> |
|
115 | 104 |
<li> |
116 |
Are all sections configured. If so, show |
|
117 |
<a HREF="metacatconfigure.html#main-config">Main Configuration Page</a> but |
|
118 |
Include instructions for restarting Metacat server. |
|
105 |
Are all sections configured? If so, show |
|
106 |
<a HREF="metacatconfigure.html#main-config">Main Configuration Page</a> which |
|
107 |
include instructions for going to Metacat server (or restarting Metacat if you |
|
108 |
are reconfiguring a running server). |
|
119 | 109 |
</li> |
120 |
</li> |
|
121 | 110 |
</ul> |
122 | 111 |
|
123 | 112 |
<p> See the following sections for descriptions of how each of these work.</p> |
124 |
</td> |
|
125 |
</tr> |
|
126 |
</table> |
|
127 | 113 |
|
128 |
<table class="tabledefault" width="100%"> |
|
129 |
<td class="tablehead" colspan="2"><p><a name="ldap-config"><h2>LDAP Configuration</h2></p></td> |
|
130 |
<tr> |
|
131 |
<td> |
|
114 |
<a name="LdapConfig"></a><div class="header1">LDAP Configuration</div> |
|
115 |
<a name="LdapOverview"></a><div class="header2">Overview</div> |
|
116 |
<p>Metacat uses LDAP as it's primary authentication mechanism. The three main |
|
117 |
values needed are LDAP URL, LDAP Secure URL and Metacat Administrators. You need |
|
118 |
to verify that the the LDAP URL and LDAP Secure URL are correct (fig 1). |
|
119 |
<span class="emphasis">You need to make sure that your LDAP user |
|
120 |
account is entered into the MetaCat Administrators field. You will not be allowed |
|
121 |
to continue with configuration if this is missing.</span> |
|
122 |
|
|
132 | 123 |
<img class="screenshot" src="./images/ldap-config.png"/> |
133 |
</td> |
|
134 |
</tr> |
|
135 |
</table> |
|
124 |
<div class="fig-text"> fig 1 </div> |
|
125 |
|
|
126 |
<a name="GetToLdapConfig"></a><div class="header2">Getting to the LDAP Configuration</div> |
|
127 |
<p>You will automatically be sent to the LDAP Configuration page if this is a new |
|
128 |
installation or upgrade.</p> |
|
129 |
|
|
130 |
<p>You can also get to the LDAP configuration from a running Metacat by typing:</p> |
|
131 |
<div class="code"><your_context_url>/admin</div> |
|
132 |
<p>You will be required to log in as an administrator and restart Metacat once you |
|
133 |
make changes.</p> |
|
134 |
|
|
135 |
<a name="ConfigLdapNoAuth"></a><div class="header2">Changing LDAP Configuration Without Authentication</div> |
|
136 |
<p>There is one exception to the log in rule. That is when you need to change or add |
|
137 |
LDAP information, but you can't authenticate using the existing setup. For example:</p> |
|
138 |
|
|
139 |
<ul> |
|
140 |
<li>The existing Metacat administrator is no longer available</li> |
|
141 |
<li>You forgot the administrator password.</li> |
|
142 |
<li>The configured LDAP urls are unavailable and you need to configure new ones.</li> |
|
143 |
</ul> |
|
144 |
|
|
145 |
<p>In this case, you will need to edit the Metacat configuration file by hand and |
|
146 |
make the changes. This insures that only a person who has access to the Metacat |
|
147 |
server and the configuration files on that server will be able to change the |
|
148 |
administrator accounts</p> |
|
149 |
|
|
150 |
<p>Stop Tomcat and edit the Metacat properties file at:</p> |
|
151 |
<div class="code"><webapp_dir>/<context_dir>/WEB-INF/metacat.properties</div> |
|
152 |
<p>where <webapp_dir> is the place that Tomcat looks for applications and |
|
153 |
<context_dir> is the name of the Metacat application (usually knb). Change the |
|
154 |
following properties appropriately:</p> |
|
155 |
|
|
156 |
<ul> |
|
157 |
<li>ldap.administrators - a colon separated list of administrators</li> |
|
158 |
<li>ldap.url - the LDAP server url</li> |
|
159 |
<li>ldap.surl - the LDAP secure server url</li> |
|
160 |
</ul> |
|
161 |
|
|
162 |
<p>Save the metacat.properties file and start Tomcat.</p> |
|
163 |
|
Also available in: Unified diff
Add instructions for configuring metacat ldap.