Revision 880
Added by Matt Jones about 23 years ago
docs/user/metacatinstall.html | ||
---|---|---|
189 | 189 |
Authorized users can check it out of the NCEAS |
190 | 190 |
<a href="http://www.nceas.ucsb.edu/cgi-bin/cvsweb.cgi/xmltodb/">CVS</a> |
191 | 191 |
system under the module name xmltodb. The command is as follows: |
192 |
<pre>cvs checkout xmltodb</pre> Or you can |
|
192 |
<pre>cvs checkout -P xmltodb</pre> Or you can
|
|
193 | 193 |
<a href="@server@/software/download.html">download</a> a gzipped tar file |
194 | 194 |
from this site. |
195 | 195 |
</p> |
... | ... | |
200 | 200 |
sample build.xml file is shown below. |
201 | 201 |
<pre> |
202 | 202 |
<property name="jdbc-connect" value="jdbc:oracle:thin:@dev.nceas.ucsb.edu:1521:exp"/> |
203 |
<property name="dbDriver" value="oracle.jdbc.driver.OracleDriver"/> |
|
203 | 204 |
<property name="installdir" value="/opt/tomcat/webapps/metadata" /> |
204 | 205 |
<property name="name" value="metacat"/> |
205 | 206 |
<property name="Name" value="MetaCat"/> |
206 |
<property name="release" value="1.0a8"/>
|
|
207 |
<property name="web-base-url" value="http://www.nceas.ucsb.edu/collab/2840/knbweb"/>
|
|
207 |
<property name="release" value="1.0.1"/>
|
|
208 |
<property name="web-base-url" value="http://knb.ecoinformatics.org"/>
|
|
208 | 209 |
<property name="replication-path" value="/metadata/servlet/replication"/> |
209 | 210 |
<property name="servlet-path" value="/metadata/servlet/metacat"/> |
210 | 211 |
<property name="html-path" value="/metadata"/> |
211 | 212 |
<property name="image-path" value="/img/metadata" /> |
212 |
<property name="server" value="dev.nceas.ucsb.edu"/> |
|
213 |
<property name="style-path" value="/jones/style"/> |
|
214 |
<property name="server" value="metacat.nceas.ucsb.edu"/> |
|
213 | 215 |
<property name="replication-log" value="metacatreplication.log"/> |
214 |
<property name="dataport" value="4444"/> |
|
215 | 216 |
<property name="user" value="metadata"/> |
216 | 217 |
<property name="password" value="your-pw-goes-here"/> |
218 |
<property name="config-dir" value="${installdir}" /> |
|
219 |
<property name="default-style" value="knb" /> |
|
220 |
<property name="eml-module" value="mdstandards/eml" /> |
|
221 |
<property name="eml-version" value="2.0.0beta6" /> |
|
222 |
<property name="eml-tag" value="RELEASE_EML_2_0_0_BETA_6" /> |
|
223 |
<property name="cvsroot" |
|
224 |
value=":ext:jones@cvs.nceas.ucsb.edu:/cvs/pbi" /> |
|
225 |
|
|
226 |
|
|
217 | 227 |
</pre> |
218 | 228 |
</p> |
219 | 229 |
<p> |
220 |
The configuration changes that you need to make are the jdbc-connect, installdir,
|
|
221 |
web-base-url, replication-path, servlet-path, html-path, image-path, server,
|
|
222 |
replication-log, user and password. Each is described
|
|
223 |
below. |
|
230 |
The configuration changes that you need to make are the jdbc-connect, |
|
231 |
installdir, web-base-url, replication-path, servlet-path, html-path,
|
|
232 |
image-path, style-path, server, replication-log, user and password.
|
|
233 |
Each is described below.
|
|
224 | 234 |
</p> |
225 | 235 |
<ul> |
226 | 236 |
<li> |
227 | 237 |
The jdbc-connect parameter is the JDBC connection string needed to connect |
228 |
to your database. If you are not using Oracle, you will also need to change |
|
229 |
the name of the JDBC driver in the <a href="./properties.html"?>metacat.properties</a> |
|
230 |
file. |
|
238 |
to your database. |
|
231 | 239 |
</li> |
232 | 240 |
<li> |
241 |
The dbDriver parameter is the name of the JDBC driver class to use for |
|
242 |
connections to your database. If you are not using Oracle, you will also |
|
243 |
need to change the name of the database adapter class in the dbAdapter |
|
244 |
property in the <a href="./properties.html"?>metacat.properties</a> file. |
|
245 |
</li> |
|
246 |
<li> |
|
233 | 247 |
The installdir |
234 | 248 |
parameter is the directory that you want Ant to install the servlet to. |
235 | 249 |
It is your "servlet context path" that was defined above. |
236 | 250 |
</li> |
237 | 251 |
<li> |
238 |
Web-base-url is the URL from which you want to load any stylesheets or supplementary
|
|
239 |
images. |
|
252 |
Web-base-url is the URL from which you want to load any stylesheets |
|
253 |
or supplementary images.
|
|
240 | 254 |
</li> |
241 | 255 |
<li> |
242 |
Replication path is the relative path to the replication servlet. This is
|
|
256 |
Replication path is the relative path to the replication servlet. This |
|
243 | 257 |
should be the name of your servlet followed by "/servlet/replication". |
244 | 258 |
</li> |
245 | 259 |
<li> |
... | ... | |
268 | 282 |
write to this directory. |
269 | 283 |
</li> |
270 | 284 |
<li> |
271 |
The user and password parmaters are the Oracle user name that you set up
|
|
272 |
to use Metacat. |
|
285 |
The user and password parmaters are the database user name that you set up
|
|
286 |
to use Metacat, for example an Oracle username and password.
|
|
273 | 287 |
</li> |
288 |
<li> |
|
289 |
The config-dir parameter specifies the location of the configuration files |
|
290 |
for the "style-sets" feature. It is set by default to the installation |
|
291 |
directory and generally does not need to be changed. |
|
292 |
</li> |
|
293 |
<li> |
|
294 |
The default-style parameter defines the "style-set" that is to be used |
|
295 |
by default when the qformat parameter is missing or set to "html" during |
|
296 |
a query. It is set to "knb", which is the only style that ships with the |
|
297 |
default metacat distribution. If you create your own stylesheets for |
|
298 |
displaying metacat output, you may want to create a new config file in the |
|
299 |
config-dir (e.g., mystyle.xml) and then change the default-style to use |
|
300 |
your custom style (e.g., "mystyle"). |
|
301 |
</li> |
|
302 |
<li> |
|
303 |
The eml-module, eml-version, eml-tag parameters control the installation |
|
304 |
behavior with respect to EML. You should not need to change these paramters. |
|
305 |
</li> |
|
306 |
<li> |
|
307 |
The cvsrootparameter is used when building the distribution and you should |
|
308 |
not need to change it. |
|
309 |
</li> |
|
274 | 310 |
</ul> |
275 | 311 |
<p class="emphasis"> |
276 | 312 |
Note: DO NOT add a slash [/] to the end of these paths. Metacat will not |
... | ... | |
345 | 381 |
access to one or more of the directories that are listed in the build.xml |
346 | 382 |
file. |
347 | 383 |
</p> |
384 |
<p>Once metacat itself is installed, you have the option of also installing |
|
385 |
the Ecological Metadata Language (EML) DTDs. This process is done most |
|
386 |
easily by running "ant instdtd" which copies the DTDs to the installation |
|
387 |
directory, and then "ant dtdsql" which registers the DTDs with the |
|
388 |
metacat server. Your database username and password have to be set correctly |
|
389 |
for this to work. |
|
348 | 390 |
<p> |
349 | 391 |
Once you have successfully installed Metacat, there is one more step. Tomcat |
350 | 392 |
(and Apache if you have Tomcat integrated with it) must be restarted. To do |
... | ... | |
363 | 405 |
Next, try to run your new servlet. Go to a web browser and type: |
364 | 406 |
<pre>http://yourserver.yourdomain.com/metadata/</pre> |
365 | 407 |
If everything is working correctly, you should see a query page followed |
366 |
by a null result set. Note that if you do not have Tomcat integrated with
|
|
408 |
by an empty result set. Note that if you do not have Tomcat integrated with
|
|
367 | 409 |
Apache you will probably have to type |
368 | 410 |
<pre>http://yourserver.yourdomain.com:8080/metadata/</pre> |
369 | 411 |
</p> |
Also available in: Unified diff
Updated the installation doc to reflect the new install procedure.