| 20 |
20 |
|
| 21 |
21 |
Metacat Server Properties
|
| 22 |
22 |
|
| 23 |
|
+--------------------+------------------------------------------------------------------------------------------+------------------------+
|
| 24 |
|
| Property | Description | Example |
|
| 25 |
|
+====================+==========================================================================================+========================+
|
| 26 |
|
| .. _server-name: | | |
|
| 27 |
|
| | | |
|
| 28 |
|
| server.name | The network host name used to access Metacat. Note that this is not necessarily | knb.ecoinformatics.org |
|
| 29 |
|
| | the physical name of the server running Metacat. The host name should not | |
|
| 30 |
|
| | include the protocol prefix (http://). | |
|
| 31 |
|
| | | |
|
| 32 |
|
| | Default Value: localhost | |
|
| 33 |
|
+--------------------+------------------------------------------------------------------------------------------+------------------------+
|
| 34 |
|
| .. _server-httpPort: | | |
|
| 35 |
|
| | | |
|
| 36 |
|
| server.httpPort | The network port used to access Metacat for non-secure (standard) connections. | 80 |
|
| 37 |
|
| | This is usually 80 if Apache Web server is running, and 8080 if Tomcat is running alone. | |
|
| 38 |
|
| | | |
|
| 39 |
|
| | Default Value: 80 | |
|
| 40 |
|
+--------------------+------------------------------------------------------------------------------------------+------------------------+
|
|
23 |
+---------------------------+------------------------------------------------------------------------------------------+------------------------+
|
|
24 |
| Property | Description | Example |
|
|
25 |
+===========================+==========================================================================================+========================+
|
|
26 |
| .. _server-name: | | |
|
|
27 |
| | | |
|
|
28 |
| server.name | The network host name used to access Metacat. Note that this is not necessarily | knb.ecoinformatics.org |
|
|
29 |
| | the physical name of the server running Metacat. The host name should not | |
|
|
30 |
| | include the protocol prefix (http://). | |
|
|
31 |
| | | |
|
|
32 |
| | Default Value: localhost | |
|
|
33 |
+---------------------------+------------------------------------------------------------------------------------------+------------------------+
|
|
34 |
| .. _server-httpPort: | | |
|
|
35 |
| | | |
|
|
36 |
| server.httpPort | The network port used to access Metacat for non-secure (standard) connections. | 80 |
|
|
37 |
| | This is usually 80 if Apache Web server is running, and 8080 if Tomcat is running alone. | |
|
|
38 |
| | | |
|
|
39 |
| | Default Value: 80 | |
|
|
40 |
+---------------------------+------------------------------------------------------------------------------------------+------------------------+
|
| 41 |
41 |
| .. _server-httpSSLPort: | | |
|
| 42 |
|
| | | |
|
| 43 |
|
| server.httpSSLPort | The network port used to access Metacat for secure connections. This is usually | 443 |
|
| 44 |
|
| | 443 if Apache Web server is running, and 8443 if Tomcat is running alone. | |
|
| 45 |
|
| | | |
|
| 46 |
|
| | Default Value: 443 | |
|
| 47 |
|
+--------------------+------------------------------------------------------------------------------------------+------------------------+
|
|
42 |
| | | |
|
|
43 |
| server.httpSSLPort | The network port used to access Metacat for secure connections. This is usually | 443 |
|
|
44 |
| | 443 if Apache Web server is running, and 8443 if Tomcat is running alone. | |
|
|
45 |
| | | |
|
|
46 |
| | Default Value: 443 | |
|
|
47 |
+---------------------------+------------------------------------------------------------------------------------------+------------------------+
|
| 48 |
48 |
|
| 49 |
49 |
Application Properties
|
| 50 |
50 |
----------------------
|
| ... | ... | |
| 53 |
53 |
be edited manually in the ``metacat.properties`` file are marked. All
|
| 54 |
54 |
others are managed with the properties configuration utility.
|
| 55 |
55 |
|
| 56 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 57 |
|
| Property | Description | Example |
|
| 58 |
|
+================================+=============================================================================+===============================+
|
| 59 |
|
| application.metacatVersion* | The Metacat version number. It is set by the build engineer | 1.9.0 |
|
| 60 |
|
| | at build time. Usually, the value should never be changed. | |
|
| 61 |
|
| | | |
|
| 62 |
|
| | Default Value: X.X.X (where X.X.X is the current version of Metacat) | |
|
| 63 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 64 |
|
| application.metacatReleaseInfo*| Release information for display purposes. Typically the property | Release Candidate 1 |
|
| 65 |
|
| | is set during the release candidate cycle to let users know which | |
|
| 66 |
|
| | candidate they are downloading. | |
|
| 67 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 68 |
|
| .. _application.deployDir: | | |
|
| 69 |
|
| | | |
|
| 70 |
|
| application.deployDir | The directory where Web applications are deployed. Usually, the value | /usr/local/tomcat/webapps |
|
| 71 |
|
| | is a directory named "webapps" in the Tomcat installation directory. | |
|
| 72 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 73 |
|
| .. _application.context: | | |
|
| 74 |
|
| | | |
|
| 75 |
|
| application.context | The name of the Metacat application directory in | knb |
|
| 76 |
|
| | the deployment directory. This corresponds to the first part of the | |
|
| 77 |
|
| | WAR file name (the part before .war). Most commonly, this | |
|
| 78 |
|
| | is "knb", but it can be changed to other things. | |
|
| 79 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 80 |
|
| .. _application.default-style: | | |
|
| 81 |
|
| | | |
|
| 82 |
|
| application.default-style | A custom Metacat Web skin usually associated with | default |
|
| 83 |
|
| | an organizational theme. If your organization has no | |
|
| 84 |
|
| | custom skin, leave the value as "default". | |
|
| 85 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 86 |
|
| .. _application.knbSiteURL: | | |
|
| 87 |
|
| | | |
|
| 88 |
|
| application.knbSiteURL | The main KNB website. | http://knb.ecoinformatics.org |
|
| 89 |
|
| | | |
|
| 90 |
|
| | Default Value: http://knb.ecoinformatics.org | |
|
| 91 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 92 |
|
| .. _application.datafilepath: | | |
|
| 93 |
|
| | | |
|
| 94 |
|
| application.datafilepath | The directory in which to store data files. The directory should | /var/metacat/data |
|
| 95 |
|
| | be outside the Metacat installation directories so data files will not | |
|
| 96 |
|
| | be lost when Metacat is upgraded. The data file directory must be | |
|
| 97 |
|
| | writable by the user that starts Tomcat (and thus Metacat). | |
|
| 98 |
|
| | | |
|
| 99 |
|
| | Default Value: /var/metacat/data | |
|
| 100 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 101 |
|
| .. _application.inlinedatafilepath: | | |
|
| 102 |
|
| | | |
|
| 103 |
|
| application.inlinedatafilepath | The directory where inline data files will be stored. Inline | /var/metacat/inline-data |
|
| 104 |
|
| | data files are created from data that is embedded in EML | |
|
| 105 |
|
| | metadata. The directory should be outside the Metacat installation | |
|
| 106 |
|
| | directories so data files will not be lost when Metacat is upgraded. | |
|
| 107 |
|
| | For clarity of data, this should probably not be the same as | |
|
| 108 |
|
| | ``application.datafilepath``. The data file directory must be | |
|
| 109 |
|
| | writable by the user that starts Tomcat (and thus Metacat). | |
|
| 110 |
|
| | | |
|
| 111 |
|
| | Default Value: /var/metacat/inline-data | |
|
| 112 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 113 |
|
| .. _application.documentfilepath: | | |
|
| 114 |
|
| | | |
|
| 115 |
|
| application.documentfilepath | The directory where metadata files will be stored. | /var/metacat/documents |
|
| 116 |
|
| | The directory should be outside the Metacat installation directories | |
|
| 117 |
|
| | so document files will not be lost when Metacat is upgraded. For | |
|
| 118 |
|
| | clarity of organization, this should probably not be the same as | |
|
| 119 |
|
| | ``application.datafilepath`` or ``application.inlinedatafilepath``. | |
|
| 120 |
|
| | The data file directory must be writable by the user that | |
|
| 121 |
|
| | starts Tomcat (and thus Metacat). | |
|
| 122 |
|
| | | |
|
| 123 |
|
| | Default Value: /var/metacat/documents | |
|
| 124 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 125 |
|
| .. _application.tempDir: | | |
|
| 126 |
|
| | | |
|
| 127 |
|
| application.tempDir | The directory where the Metacat data registry stores temporary | /var/metacat/temporary |
|
| 128 |
|
| | files. The directory should not be the same as ``application.datafilepath`` | |
|
| 129 |
|
| | or ``application.inlinedatafilepath`` (or any other persistent file path) | |
|
| 130 |
|
| | because all files in this may be purged programmatically. The temporary | |
|
| 131 |
|
| | file directory must be writable by the user that starts Apache. | |
|
| 132 |
|
| | | |
|
| 133 |
|
| | Default Value: /var/metacat/temporary | |
|
| 134 |
|
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
56 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
57 |
| Property | Description | Example |
|
|
58 |
+======================================+=============================================================================+===============================+
|
|
59 |
| application.metacatVersion* | The Metacat version number. It is set by the build engineer | 1.9.0 |
|
|
60 |
| | at build time. Usually, the value should never be changed. | |
|
|
61 |
| | | |
|
|
62 |
| | Default Value: X.X.X (where X.X.X is the current version of Metacat) | |
|
|
63 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
64 |
| application.metacatReleaseInfo* | Release information for display purposes. Typically the property | Release Candidate 1 |
|
|
65 |
| | is set during the release candidate cycle to let users know which | |
|
|
66 |
| | candidate they are downloading. | |
|
|
67 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
68 |
| .. _application.deployDir: | | |
|
|
69 |
| | | |
|
|
70 |
| application.deployDir | The directory where Web applications are deployed. Usually, the value | /usr/local/tomcat/webapps |
|
|
71 |
| | is a directory named "webapps" in the Tomcat installation directory. | |
|
|
72 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
73 |
| .. _application.context: | | |
|
|
74 |
| | | |
|
|
75 |
| application.context | The name of the Metacat application directory in | knb |
|
|
76 |
| | the deployment directory. This corresponds to the first part of the | |
|
|
77 |
| | WAR file name (the part before .war). Most commonly, this | |
|
|
78 |
| | is "knb", but it can be changed to other things. | |
|
|
79 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
80 |
| .. _index.context: | | |
|
|
81 |
| | | |
|
|
82 |
| index.context | The name of the Metacat index webapp in | metacat-index |
|
|
83 |
| | the deployment directory. Most commonly, this | |
|
|
84 |
| | is "metacat-index", but it can be changed if needed. | |
|
|
85 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
86 |
| .. _ui.context: | | |
|
|
87 |
| | | |
|
|
88 |
| ui.context | The name of the Metacat UI directory in | metacatui |
|
|
89 |
| | the deployment directory. Often the UI is deployed | |
|
|
90 |
| | as the ROOT webapp, in which case the property should be blank (""). | |
|
|
91 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
92 |
| .. _application.default-style: | | |
|
|
93 |
| | | |
|
|
94 |
| application.default-style | A custom Metacat Web skin usually associated with | default |
|
|
95 |
| | an organizational theme. If your organization has no | |
|
|
96 |
| | custom skin, leave the value as "default". | |
|
|
97 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
98 |
| .. _application.knbSiteURL: | | |
|
|
99 |
| | | |
|
|
100 |
| application.knbSiteURL | The main KNB website. | http://knb.ecoinformatics.org |
|
|
101 |
| | | |
|
|
102 |
| | Default Value: http://knb.ecoinformatics.org | |
|
|
103 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
104 |
| .. _application.datafilepath: | | |
|
|
105 |
| | | |
|
|
106 |
| application.datafilepath | The directory in which to store data files. The directory should | /var/metacat/data |
|
|
107 |
| | be outside the Metacat installation directories so data files will not | |
|
|
108 |
| | be lost when Metacat is upgraded. The data file directory must be | |
|
|
109 |
| | writable by the user that starts Tomcat (and thus Metacat). | |
|
|
110 |
| | | |
|
|
111 |
| | Default Value: /var/metacat/data | |
|
|
112 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
113 |
| .. _application.inlinedatafilepath: | | |
|
|
114 |
| | | |
|
|
115 |
| application.inlinedatafilepath | The directory where inline data files will be stored. Inline | /var/metacat/inline-data |
|
|
116 |
| | data files are created from data that is embedded in EML | |
|
|
117 |
| | metadata. The directory should be outside the Metacat installation | |
|
|
118 |
| | directories so data files will not be lost when Metacat is upgraded. | |
|
|
119 |
| | For clarity of data, this should probably not be the same as | |
|
|
120 |
| | ``application.datafilepath``. The data file directory must be | |
|
|
121 |
| | writable by the user that starts Tomcat (and thus Metacat). | |
|
|
122 |
| | | |
|
|
123 |
| | Default Value: /var/metacat/inline-data | |
|
|
124 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
125 |
| .. _application.documentfilepath: | | |
|
|
126 |
| | | |
|
|
127 |
| application.documentfilepath | The directory where metadata files will be stored. | /var/metacat/documents |
|
|
128 |
| | The directory should be outside the Metacat installation directories | |
|
|
129 |
| | so document files will not be lost when Metacat is upgraded. For | |
|
|
130 |
| | clarity of organization, this should probably not be the same as | |
|
|
131 |
| | ``application.datafilepath`` or ``application.inlinedatafilepath``. | |
|
|
132 |
| | The data file directory must be writable by the user that | |
|
|
133 |
| | starts Tomcat (and thus Metacat). | |
|
|
134 |
| | | |
|
|
135 |
| | Default Value: /var/metacat/documents | |
|
|
136 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
137 |
| .. _application.tempDir: | | |
|
|
138 |
| | | |
|
|
139 |
| application.tempDir | The directory where the Metacat data registry stores temporary | /var/metacat/temporary |
|
|
140 |
| | files. The directory should not be the same as ``application.datafilepath`` | |
|
|
141 |
| | or ``application.inlinedatafilepath`` (or any other persistent file path) | |
|
|
142 |
| | because all files in this may be purged programmatically. The temporary | |
|
|
143 |
| | file directory must be writable by the user that starts Apache. | |
|
|
144 |
| | | |
|
|
145 |
| | Default Value: /var/metacat/temporary | |
|
|
146 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
|
147 |
| .. _solr.homeDir: | | |
|
|
148 |
| | | |
|
|
149 |
| solr.homeDir | The directory where the Metacat index component stores the SOLR index. | /var/metacat/solr-home |
|
|
150 |
| | The directory must be writable by the user that starts Tomcat. | |
|
|
151 |
| | | |
|
|
152 |
| | Default Value: /var/metacat/solr-home | |
|
|
153 |
+--------------------------------------+-----------------------------------------------------------------------------+-------------------------------+
|
| 135 |
154 |
|
| 136 |
155 |
Database Properties
|
| 137 |
156 |
-------------------
|
| ... | ... | |
| 177 |
196 |
| database.adapter | The adapter class that allows Metacat to access your database type. | edu.ucsb.nceas.dbadapter.PostgresqlAdapter |
|
| 178 |
197 |
| | There is one adapter associated with each type of database. | |
|
| 179 |
198 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+
|
| 180 |
|
| .. _database-scriptsuf | | |
|
|
199 |
| .. _database-scriptsuf: | | |
|
| 181 |
200 |
| | | |
|
| 182 |
201 |
| database.scriptsuffix.<database_type> | The script suffix tells the system which database scripts to run | postgres.sql |
|
| 183 |
202 |
| | (postgres or oracle) when installing or updating database schema. | |
|
| ... | ... | |
| 435 |
454 |
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
| 436 |
455 |
|
| 437 |
456 |
|
|
457 |
Data Manager Properties
|
|
458 |
------------------------
|
|
459 |
The EML Data Manager is also included for extended data-query operations. Note that this feature is still experimental.
|
|
460 |
|
|
461 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
|
462 |
| Property | Description | Example |
|
|
463 |
+===================================+===============================================================================+===============================================+
|
|
464 |
| .. _datamanager.server: | | |
|
|
465 |
| | | |
|
|
466 |
| datamanager.server | The server for the Datamanager library to use for temporary db storage | localhost |
|
|
467 |
| | | |
|
|
468 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
|
469 |
| .. _datamanager.database: | | |
|
|
470 |
| | | |
|
|
471 |
| datamanager.database | The database name for the Datamanager | datamananger |
|
|
472 |
| | | |
|
|
473 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
|
474 |
| .. _datamanager.user: | | |
|
|
475 |
| | | |
|
|
476 |
| datamanager.user | The username for the Datamanager DB | datamananger |
|
|
477 |
| | | |
|
|
478 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
|
479 |
| .. _datamanager.password: | | |
|
|
480 |
| | | |
|
|
481 |
| datamanager.password | The password for the Datamanager user | datamananger |
|
|
482 |
| | | |
|
|
483 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+
|
|
484 |
|
|
485 |
|
|
486 |
Additional Properties
|
|
487 |
----------------------
|
|
488 |
Additional configuration properties are described below, though there are many more that can be manually edited in the properties file directly.
|
|
489 |
|
|
490 |
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
|
491 |
| Property | Description | Example |
|
|
492 |
+=======================+==================================================================+===================================================+
|
|
493 |
| plugin.handlers | Implementations of the plugin interface: | org.example.CustomActionHandler |
|
|
494 |
| | edu.ucsb.nceas.metacat.plugin.MetacatHandlerPlugin can be listed | |
|
|
495 |
| | | |
|
|
496 |
| | Default Value: blank | |
|
|
497 |
+-----------------------+------------------------------------------------------------------+---------------------------------------------------+
|
|
498 |
|
add documentation entries for fields that appear on the main metacat admin page.