| 13 |
13 |
-->
|
| 14 |
14 |
<HTML>
|
| 15 |
15 |
<HEAD>
|
| 16 |
|
<TITLE>Metacat Properties File</TITLE>
|
|
16 |
<TITLE>Metacat Properties Files</TITLE>
|
| 17 |
17 |
<link rel="stylesheet" type="text/css" href="./default.css">
|
| 18 |
18 |
</HEAD>
|
| 19 |
19 |
<BODY>
|
| ... | ... | |
| 26 |
26 |
</td>
|
| 27 |
27 |
</tr>
|
| 28 |
28 |
</table>
|
| 29 |
|
<p>Metacat Server has many dynamically settable properties.
|
| 30 |
|
All of them are kept in the <em>metacat.properties</em> file.
|
| 31 |
|
Most <a href="./metacatinstall.html#buildProperties">can be set from within
|
| 32 |
|
the build file</a> when you first install Metacat.
|
| 33 |
|
The following is a summary of each property and its function.
|
|
29 |
<p> Metacat Server has properties that are stored in two general locations.
|
|
30 |
Global properties are held in:
|
|
31 |
<p class="indent"><em><CONTEXT_DIR>*/WEB_INF/metacat.properties</em>.</p>
|
|
32 |
Skin specific properties are set on a per-skin basis in:
|
|
33 |
<p class="indent"><em><CONTEXT_DIR>*/WEB_INF/style/skins/<SKIN_NAME>/<SKIN_NAME>.properties</em></p>
|
|
34 |
</p>
|
|
35 |
|
|
36 |
<p>
|
|
37 |
The most dynamic properties are modified using the internal <a href="./metacatconfigure.html">Metacat configuration utility </a>.
|
|
38 |
However, it may be necessary to manually edit a configuration file to update more static values.
|
|
39 |
</p>
|
|
40 |
|
|
41 |
<p>
|
|
42 |
The list of properties shown on this page gives the following information about each property:
|
|
43 |
<ul>
|
|
44 |
<li> <b>Property Name</b> - the header for each section is the name of the
|
|
45 |
property as it appears in the property file.</li>
|
|
46 |
<li> <b>Default Value</b> - the default value set for that property if any. </li>
|
|
47 |
<li> <b>Description</b> - what does the property control and how can it be set. </li>
|
|
48 |
<li> <b>Set Method</b> - how does the value get set in the properties file. There are
|
|
49 |
two options:
|
|
50 |
<ul>
|
|
51 |
<li> Configuration Utility - the value is set via the internal <a href="./metacatconfigure.html">Metacat configuration utility </a></li>
|
|
52 |
<li> Manually - the value is set to a default that can only be changed by manually editing the configuration file. </li>
|
|
53 |
</ul>
|
|
54 |
<li> <b>Example</b> - an example setting for the property.</li>
|
|
55 |
</ul>
|
| 34 |
56 |
</p>
|
|
57 |
|
|
58 |
<p class="footnote">
|
|
59 |
(* CONTEXT_DIR refers to the directory where the Metacat application code
|
|
60 |
lives. This is a combination of the web application directory and the
|
|
61 |
metacat context directory. This usually looks something like
|
|
62 |
/usr/local/tomcat/webapps/knb. However, your webapps directory could
|
|
63 |
be somewhere besides the tomcat directory and your context could be
|
|
64 |
something other than knb.)
|
|
65 |
</p>
|
|
66 |
|
|
67 |
<h1>Global Metacat Properties - (metacat.properties) </h1>
|
|
68 |
<hr>
|
|
69 |
|
|
70 |
<a name="server.name"></a><h1 class="property-main"> server.name </h1>
|
|
71 |
<div class="property-description-line">
|
|
72 |
<h2 class="property-inline"> Default Value: </h2>
|
|
73 |
<p class="property-text">localhost</p>
|
|
74 |
</div>
|
|
75 |
<div class="property-description-line">
|
|
76 |
<h2 class="property-inline"> Set Method: </h2>
|
|
77 |
<p class="property-text">Configuration Utility</p>
|
|
78 |
</div>
|
|
79 |
<div class="property-description-line">
|
|
80 |
<h2 class="property-inline"> Description: </h2>
|
|
81 |
<p class="property-text">The network host name that will be
|
|
82 |
used to access Metacat. Note that this is not necessarily the physical
|
|
83 |
name of the server running Metacat. The host name should not include
|
|
84 |
the protocol prefix (http://).</p>
|
|
85 |
</div>
|
|
86 |
<div class="property-description-line">
|
|
87 |
<h2 class="property-inline"> Example: </h2>
|
|
88 |
<p class="property-text">knb.ecoinformatics.org</p>
|
|
89 |
</div>
|
|
90 |
|
|
91 |
<a name="server.httpPort"></a><h1 class="property-main"> server.httpPort </h1>
|
|
92 |
<div class="property-description-line">
|
|
93 |
<h2 class="property-inline"> Default Value: </h2>
|
|
94 |
<p class="property-text">80</p>
|
|
95 |
</div>
|
|
96 |
<div class="property-description-line">
|
|
97 |
<h2 class="property-inline"> Set Method: </h2>
|
|
98 |
<p class="property-text">Configuration Utility</p>
|
|
99 |
</div>
|
|
100 |
<div class="property-description-line">
|
|
101 |
<h2 class="property-inline"> Description: </h2>
|
|
102 |
<p class="property-text">The network port that will be
|
|
103 |
used to access Metacat for non-secure (standard) connections.
|
|
104 |
This is usually 80 if Apache web server is running (typical install), and
|
|
105 |
8080 if Tomcat is running alone, but both Apache and Tomcat could
|
|
106 |
have been configured to listen on alternate ports. </p>
|
|
107 |
</div>
|
|
108 |
<div class="property-description-line">
|
|
109 |
<h2 class="property-inline"> Example: </h2>
|
|
110 |
<p class="property-text">80</p>
|
|
111 |
</div>
|
|
112 |
|
|
113 |
<a name="server.httpSSLPort"></a><h1 class="property-main"> server.httpSSLPort </h1>
|
|
114 |
<div class="property-description-line">
|
|
115 |
<h2 class="property-inline"> Default Value: </h2>
|
|
116 |
<p class="property-text">443</p>
|
|
117 |
</div>
|
|
118 |
<div class="property-description-line">
|
|
119 |
<h2 class="property-inline"> Set Method: </h2>
|
|
120 |
<p class="property-text">Configuration Utility</p>
|
|
121 |
</div>
|
|
122 |
<div class="property-description-line">
|
|
123 |
<h2 class="property-inline"> Description: </h2>
|
|
124 |
<p class="property-text">The network port that will be
|
|
125 |
used to access Metacat for secure connections.
|
|
126 |
This is usually 443 if Apache web server is running (typical install), and
|
|
127 |
8443 if Tomcat is running alone, but both Apache and Tomcat could
|
|
128 |
have been configured to listen on alternate ports. </p>
|
|
129 |
</div>
|
|
130 |
<div class="property-description-line">
|
|
131 |
<h2 class="property-inline"> Example: </h2>
|
|
132 |
<p class="property-text">443</p>
|
|
133 |
</div>
|
|
134 |
|
|
135 |
<br>
|
|
136 |
|
|
137 |
<a name="application.metacatVersion"></a><h1 class="property-main"> application.metacatVersion </h1>
|
|
138 |
<div class="property-description-line">
|
|
139 |
<h2 class="property-inline"> Default Value: </h2>
|
|
140 |
<p class="property-text">1.9.0</p>
|
|
141 |
</div>
|
|
142 |
<div class="property-description-line">
|
|
143 |
<h2 class="property-inline"> Set Method: </h2>
|
|
144 |
<p class="property-text">Manual</p>
|
|
145 |
</div>
|
|
146 |
<div class="property-description-line">
|
|
147 |
<h2 class="property-inline"> Description: </h2>
|
|
148 |
<p class="property-text">The Metacat version number. usually, this should
|
|
149 |
never be changed. It is set by the build engineer at build time.</p>
|
|
150 |
</div>
|
|
151 |
<div class="property-description-line">
|
|
152 |
<h2 class="property-inline"> Example: </h2>
|
|
153 |
<p class="property-text">1.9.0</p>
|
|
154 |
</div>
|
|
155 |
|
|
156 |
<a name="application.deployDir"></a><h1 class="property-main"> application.deployDir </h1>
|
|
157 |
<div class="property-description-line">
|
|
158 |
<h2 class="property-inline"> Default Value: </h2>
|
|
159 |
<p class="property-text">(none)</p>
|
|
160 |
</div>
|
|
161 |
<div class="property-description-line">
|
|
162 |
<h2 class="property-inline"> Set Method: </h2>
|
|
163 |
<p class="property-text">Configuration Utility</p>
|
|
164 |
</div>
|
|
165 |
<div class="property-description-line">
|
|
166 |
<h2 class="property-inline"> Description: </h2>
|
|
167 |
<p class="property-text">The directory where web applications are deployed.
|
|
168 |
Many times this is in a directory named "webapps" in the Tomcat installation
|
|
169 |
directory. However, Tomcat may be configured to look in a different directory.</p>
|
|
170 |
</div>
|
|
171 |
<div class="property-description-line">
|
|
172 |
<h2 class="property-inline"> Example: </h2>
|
|
173 |
<p class="property-text">/usr/local/tomcat/webapps</p>
|
|
174 |
</div>
|
|
175 |
|
|
176 |
<a name="application.context"></a><h1 class="property-main"> application.context </h1>
|
|
177 |
<div class="property-description-line">
|
|
178 |
<h2 class="property-inline"> Default Value: </h2>
|
|
179 |
<p class="property-text">(none)</p>
|
|
180 |
</div>
|
|
181 |
<div class="property-description-line">
|
|
182 |
<h2 class="property-inline"> Set Method: </h2>
|
|
183 |
<p class="property-text">Configuration Utility</p>
|
|
184 |
</div>
|
|
185 |
<div class="property-description-line">
|
|
186 |
<h2 class="property-inline"> Description: </h2>
|
|
187 |
<p class="property-text">Applications run in individual directories in the applicaton
|
|
188 |
deployment directory. The name of the application directory is the application
|
|
189 |
context. This corresponds to the first part of the war file name (the part before .war).
|
|
190 |
Most commonly, this is "knb", but it can be changed to other things.</p>
|
|
191 |
</div>
|
|
192 |
<div class="property-description-line">
|
|
193 |
<h2 class="property-inline"> Example: </h2>
|
|
194 |
<p class="property-text">knb</p>
|
|
195 |
</div>
|
|
196 |
|
|
197 |
<a name="application.default-style"></a><h1 class="property-main"> application.default-style </h1>
|
|
198 |
<div class="property-description-line">
|
|
199 |
<h2 class="property-inline"> Default Value: </h2>
|
|
200 |
<p class="property-text">default</p>
|
|
201 |
</div>
|
|
202 |
<div class="property-description-line">
|
|
203 |
<h2 class="property-inline"> Set Method: </h2>
|
|
204 |
<p class="property-text">Configuration Utility</p>
|
|
205 |
</div>
|
|
206 |
<div class="property-description-line">
|
|
207 |
<h2 class="property-inline"> Description: </h2>
|
|
208 |
<p class="property-text">There are some custom web skins available in Metacat.
|
|
209 |
Typically these are associated with an organizational theme. If there is not
|
|
210 |
a custom skin for your organization, you should leave it as "default".</p>
|
|
211 |
</div>
|
|
212 |
<div class="property-description-line">
|
|
213 |
<h2 class="property-inline"> Example: </h2>
|
|
214 |
<p class="property-text">default</p>
|
|
215 |
</div>
|
|
216 |
|
|
217 |
<a name="application.knbSiteURL"></a><h1 class="property-main"> application.knbSiteURL </h1>
|
|
218 |
<div class="property-description-line">
|
|
219 |
<h2 class="property-inline"> Default Value: </h2>
|
|
220 |
<p class="property-text">http://knb.ecoinformatics.org</p>
|
|
221 |
</div>
|
|
222 |
<div class="property-description-line">
|
|
223 |
<h2 class="property-inline"> Set Method: </h2>
|
|
224 |
<p class="property-text">Configuration Utility</p>
|
|
225 |
</div>
|
|
226 |
<div class="property-description-line">
|
|
227 |
<h2 class="property-inline"> Description: </h2>
|
|
228 |
<p class="property-text">The KNB site to redirect to.</p>
|
|
229 |
</div>
|
|
230 |
<div class="property-description-line">
|
|
231 |
<h2 class="property-inline"> Example: </h2>
|
|
232 |
<p class="property-text">http://knb.ecoinformatics.org</p>
|
|
233 |
</div>
|
|
234 |
|
|
235 |
<a name="application.datafilepath"></a><h1 class="property-main"> application.datafilepath </h1>
|
|
236 |
<div class="property-description-line">
|
|
237 |
<h2 class="property-inline"> Default Value: </h2>
|
|
238 |
<p class="property-text">/var/metacat/data</p>
|
|
239 |
</div>
|
|
240 |
<div class="property-description-line">
|
|
241 |
<h2 class="property-inline"> Set Method: </h2>
|
|
242 |
<p class="property-text">Configuration Utility</p>
|
|
243 |
</div>
|
|
244 |
<div class="property-description-line">
|
|
245 |
<h2 class="property-inline"> Description: </h2>
|
|
246 |
<p class="property-text">This is the directory whera data files will be stored.
|
|
247 |
This should be some directory outside the Metacat installation directories so
|
|
248 |
data files will not get lost when Metacat is upgraded. The data file directory
|
|
249 |
must be writable by the user that starts Tomcat (and thus Metacat).</p>
|
|
250 |
</div>
|
|
251 |
<div class="property-description-line">
|
|
252 |
<h2 class="property-inline"> Example: </h2>
|
|
253 |
<p class="property-text">/var/metacat/data</p>
|
|
254 |
</div>
|
|
255 |
|
|
256 |
<a name="application.inlinedatafilepath"></a><h1 class="property-main"> application.inlinedatafilepath </h1>
|
|
257 |
<div class="property-description-line">
|
|
258 |
<h2 class="property-inline"> Default Value: </h2>
|
|
259 |
<p class="property-text">/var/metacat/inline-data</p>
|
|
260 |
</div>
|
|
261 |
<div class="property-description-line">
|
|
262 |
<h2 class="property-inline"> Set Method: </h2>
|
|
263 |
<p class="property-text">Configuration Utility</p>
|
|
264 |
</div>
|
|
265 |
<div class="property-description-line">
|
|
266 |
<h2 class="property-inline"> Description: </h2>
|
|
267 |
<p class="property-text">This is the directory where inline data files will
|
|
268 |
be stored. Inline data files are created from data that is embedded in EML
|
|
269 |
metadata. This should be some directory outside the Metacat installation
|
|
270 |
directories so data files will not get lost when Metacat is upgraded. For
|
|
271 |
clarity of data, this should probably not be the same as application.datafilepath.
|
|
272 |
The data file directory must be writable by the user that starts Tomcat (and thus Metacat).</p>
|
|
273 |
</div>
|
|
274 |
<div class="property-description-line">
|
|
275 |
<h2 class="property-inline"> Example: </h2>
|
|
276 |
<p class="property-text">/var/metacat/inline-data</p>
|
|
277 |
</div>
|
|
278 |
|
|
279 |
<a name="application.cgiDir"></a><h1 class="property-main"> application.cgiDir </h1>
|
|
280 |
<div class="property-description-line">
|
|
281 |
<h2 class="property-inline"> Default Value: </h2>
|
|
282 |
<p class="property-text">TODO MCD add this</p>
|
|
283 |
</div>
|
|
284 |
<div class="property-description-line">
|
|
285 |
<h2 class="property-inline"> Set Method: </h2>
|
|
286 |
<p class="property-text">Configuration Utility</p>
|
|
287 |
</div>
|
|
288 |
<div class="property-description-line">
|
|
289 |
<h2 class="property-inline"> Description: </h2>
|
|
290 |
<p class="property-text">This is the directory that is configured in
|
|
291 |
Apache web server to have CGI executables.</p>
|
|
292 |
</div>
|
|
293 |
<div class="property-description-line">
|
|
294 |
<h2 class="property-inline"> Example: </h2>
|
|
295 |
<p class="property-text">TODO MCD add this</p>
|
|
296 |
</div>
|
|
297 |
|
|
298 |
|
|
299 |
|
|
300 |
|
|
301 |
|
|
302 |
|
| 35 |
303 |
<table border="1">
|
| 36 |
304 |
<tr>
|
| 37 |
305 |
<td><b>Property</b></td>
|
| ... | ... | |
| 229 |
497 |
|
| 230 |
498 |
<tr><td colspan="3"><b>Additional properties that probably do not need to be changed</b></td></tr>
|
| 231 |
499 |
<tr><td>configured</td><td>Configuration flag</td><td>true</td></tr>
|
| 232 |
|
<tr><td>configurationPage</td><td></td>The page to do metacat configuration<td>/configure.jsp</td></tr>
|
|
500 |
<tr><td>configurationPage</td><td>The page to do metacat configuration<td>/configure.jsp</td></tr>
|
| 233 |
501 |
<tr><td>configurationSuccessPage</td><td>The page to show successful message after configuration</td><td>/configure-restart.jsp</td></tr>
|
| 234 |
502 |
<tr><td>version</td><td>Release version.</td><td>1.7.1</td></tr>
|
| 235 |
503 |
<tr><td>maximumConnectionAge</td><td> </td><td>120000</td></tr>
|
Rework properties descriptions