Revision 7425
Added by ben leinfelder over 11 years ago
| metacat-properties.rst | ||
|---|---|---|
| 23 | 23 |
+--------------------+------------------------------------------------------------------------------------------+------------------------+ |
| 24 | 24 |
| Property | Description | Example | |
| 25 | 25 |
+====================+==========================================================================================+========================+ |
| 26 |
| .. _server-name: | | | |
|
| 27 |
| | | | |
|
| 26 | 28 |
| server.name | The network host name used to access Metacat. Note that this is not necessarily | knb.ecoinformatics.org | |
| 27 | 29 |
| | the physical name of the server running Metacat. The host name should not | | |
| 28 | 30 |
| | include the protocol prefix (http://). | | |
| 29 | 31 |
| | | | |
| 30 | 32 |
| | Default Value: localhost | | |
| 31 | 33 |
+--------------------+------------------------------------------------------------------------------------------+------------------------+ |
| 34 |
| .. _server-httpPort: | | | |
|
| 35 |
| | | | |
|
| 32 | 36 |
| server.httpPort | The network port used to access Metacat for non-secure (standard) connections. | 80 | |
| 33 | 37 |
| | This is usually 80 if Apache Web server is running, and 8080 if Tomcat is running alone. | | |
| 34 | 38 |
| | | | |
| 35 | 39 |
| | Default Value: 80 | | |
| 36 | 40 |
+--------------------+------------------------------------------------------------------------------------------+------------------------+ |
| 41 |
| .. _server-httpSSLPort: | | | |
|
| 42 |
| | | | |
|
| 37 | 43 |
| server.httpSSLPort | The network port used to access Metacat for secure connections. This is usually | 443 | |
| 38 | 44 |
| | 443 if Apache Web server is running, and 8443 if Tomcat is running alone. | | |
| 39 | 45 |
| | | | |
| ... | ... | |
| 59 | 65 |
| | is set during the release candidate cycle to let users know which | | |
| 60 | 66 |
| | candidate they are downloading. | | |
| 61 | 67 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 68 |
| .. _application.deployDir: | | | |
|
| 69 |
| | | | |
|
| 62 | 70 |
| application.deployDir | The directory where Web applications are deployed. Usually, the value | /usr/local/tomcat/webapps | |
| 63 | 71 |
| | is a directory named "webapps" in the Tomcat installation directory. | | |
| 64 | 72 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 73 |
| .. _application.context: | | | |
|
| 74 |
| | | | |
|
| 65 | 75 |
| application.context | The name of the Metacat application directory in | knb | |
| 66 | 76 |
| | the deployment directory. This corresponds to the first part of the | | |
| 67 | 77 |
| | WAR file name (the part before .war). Most commonly, this | | |
| 68 | 78 |
| | is "knb", but it can be changed to other things. | | |
| 69 | 79 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 80 |
| .. _application.default-style: | | | |
|
| 81 |
| | | | |
|
| 70 | 82 |
| application.default-style | A custom Metacat Web skin usually associated with | default | |
| 71 | 83 |
| | an organizational theme. If your organization has no | | |
| 72 | 84 |
| | custom skin, leave the value as "default". | | |
| 73 | 85 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 86 |
| .. _application.knbSiteURL: | | | |
|
| 87 |
| | | | |
|
| 74 | 88 |
| application.knbSiteURL | The main KNB website. | http://knb.ecoinformatics.org | |
| 75 | 89 |
| | | | |
| 76 | 90 |
| | Default Value: http://knb.ecoinformatics.org | | |
| 77 | 91 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 92 |
| .. _application.datafilepath: | | | |
|
| 93 |
| | | | |
|
| 78 | 94 |
| application.datafilepath | The directory in which to store data files. The directory should | /var/metacat/data | |
| 79 | 95 |
| | be outside the Metacat installation directories so data files will not | | |
| 80 | 96 |
| | be lost when Metacat is upgraded. The data file directory must be | | |
| ... | ... | |
| 82 | 98 |
| | | | |
| 83 | 99 |
| | Default Value: /var/metacat/data | | |
| 84 | 100 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 101 |
| .. _application.inlinedatafilepath: | | | |
|
| 102 |
| | | | |
|
| 85 | 103 |
| application.inlinedatafilepath | The directory where inline data files will be stored. Inline | /var/metacat/inline-data | |
| 86 | 104 |
| | data files are created from data that is embedded in EML | | |
| 87 | 105 |
| | metadata. The directory should be outside the Metacat installation | | |
| ... | ... | |
| 92 | 110 |
| | | | |
| 93 | 111 |
| | Default Value: /var/metacat/inline-data | | |
| 94 | 112 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 113 |
| .. _application.documentfilepath: | | | |
|
| 114 |
| | | | |
|
| 95 | 115 |
| application.documentfilepath | The directory where metadata files will be stored. | /var/metacat/documents | |
| 96 | 116 |
| | The directory should be outside the Metacat installation directories | | |
| 97 | 117 |
| | so document files will not be lost when Metacat is upgraded. For | | |
| ... | ... | |
| 102 | 122 |
| | | | |
| 103 | 123 |
| | Default Value: /var/metacat/documents | | |
| 104 | 124 |
+--------------------------------+-----------------------------------------------------------------------------+-------------------------------+ |
| 125 |
| .. _application.tempDir: | | | |
|
| 126 |
| | | | |
|
| 105 | 127 |
| application.tempDir | The directory where the Metacat data registry stores temporary | /var/metacat/temporary | |
| 106 | 128 |
| | files. The directory should not be the same as ``application.datafilepath`` | | |
| 107 | 129 |
| | or ``application.inlinedatafilepath`` (or any other persistent file path) | | |
| ... | ... | |
| 122 | 144 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 123 | 145 |
| Property | Description | Example | |
| 124 | 146 |
+============================================+==========================================================================================================+=========================================================+ |
| 147 |
| .. _database-connectionURI: | | | |
|
| 148 |
| | | | |
|
| 125 | 149 |
| database.connectionURI | The JDBC connection URI for the main database instance of Metacat. | ``jdbc:postgresql://yourserver.yourdomain.edu/metacat`` | |
| 126 | 150 |
| | The URI is formatted like: ``jdbc:<database_type>:thin@<your_server_name>:1521:<metacat_database_name>`` | | |
| 127 | 151 |
| | NOTE: You must create an empty database prior to initial Metacat configuration. | | |
| 128 | 152 |
| | | | |
| 129 | 153 |
| | Default Value: jdbc:postgresql://localhost/metacat | | |
| 130 | 154 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 155 |
| .. _database-user: | | | |
|
| 156 |
| | | | |
|
| 131 | 157 |
| database.user | The user for the main database instance of Metacat. The user must | metacat-user | |
| 132 | 158 |
| | have already been created on the database. | | |
| 133 | 159 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 160 |
| .. _database-password: | | | |
|
| 161 |
| | | | |
|
| 134 | 162 |
| database.password | The password of the user for the main database instance of Metacat. | securepassword4843 | |
| 135 | 163 |
| | The password must have already been created for the user. | | |
| 136 | 164 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 165 |
| .. _database-type: | | | |
|
| 166 |
| | | | |
|
| 137 | 167 |
| database.type | The type of database you are running. Currently, there are two supported | postgres | |
| 138 | 168 |
| | types, Oracle and Postgres. | | |
| 139 | 169 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 170 |
| .. _database-driver: | | | |
|
| 171 |
| | | | |
|
| 140 | 172 |
| database.driver | The JDBC driver to be used to access the main database instance of Metacat. | org.postgresql.Driver | |
| 141 | 173 |
| | There is one driver associated with each type of database. | | |
| 142 | 174 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 175 |
| .. _database-adapter: | | | |
|
| 176 |
| | | | |
|
| 143 | 177 |
| database.adapter | The adapter class that allows Metacat to access your database type. | edu.ucsb.nceas.dbadapter.PostgresqlAdapter | |
| 144 | 178 |
| | There is one adapter associated with each type of database. | | |
| 145 | 179 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 180 |
| .. _database-scriptsuf | | | |
|
| 181 |
| | | | |
|
| 146 | 182 |
| database.scriptsuffix.<database_type> | The script suffix tells the system which database scripts to run | postgres.sql | |
| 147 | 183 |
| | (postgres or oracle) when installing or updating database schema. | | |
| 148 | 184 |
| | | | |
| ... | ... | |
| 150 | 186 |
| | database.scriptsuffix.postgres=postgres.sql | | |
| 151 | 187 |
| | database.scriptsuffix.oracle=oracle.sql | | |
| 152 | 188 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ |
| 189 |
| .. _database-upgradeVersion: | | | |
|
| 190 |
| | | | |
|
| 153 | 191 |
| database.upgradeVersion.<database_version> | Which database scripts to run when updating database schema. There is a | upgrade-db-to-1.2 | |
| 154 | 192 |
| | database.upgradeVersion entry for every Metacat database schema version. | | |
| 155 | 193 |
| | Each schema version corresponds to an application version. | | |
| ... | ... | |
| 270 | 308 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 271 | 309 |
| Property | Description | Example | |
| 272 | 310 |
+===================================+===============================================================================+===============================================+ |
| 311 |
| .. _auth-class: | | | |
|
| 312 |
| | | | |
|
| 273 | 313 |
| auth.class | The class used for user authentication. Currently, only the AuthLdap | edu.ucsb.nceas.metacat.AuthLdap | |
| 274 | 314 |
| | class is included in the Metacat distribution. | | |
| 275 | 315 |
| | Note: If you implement another authentication strategy by implementing a Java | | |
| ... | ... | |
| 284 | 324 |
| | | | |
| 285 | 325 |
| | Default Value: 180 | | |
| 286 | 326 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 327 |
| .. _auth-administrators: | | | |
|
| 328 |
| | | | |
|
| 287 | 329 |
| auth.administrators | A colon separated list of LDAP users or groups that have administrative | uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org | |
| 288 | 330 |
| | Metacat privileges. At least one user or group must be entered when | cn=yourgroup,o=NCEAS,dc=ecoinformatics,dc=org | |
| 289 | 331 |
| | Metacat is first installed and configured. All accounts must exist | | |
| 290 | 332 |
| | in LDAP in order to continue with the configuration. | | |
| 291 | 333 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 334 |
| .. _auth-url: | | | |
|
| 335 |
| | | | |
|
| 292 | 336 |
| auth.url | The URL of the server that Metacat should use for authentication. | ldap://ldap.ecoinformatics.org:389/ | |
| 293 | 337 |
| | | | |
| 294 | 338 |
| | Default Value: ldap://ldap.ecoinformatics.org:389/ | | |
| 295 | 339 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 340 |
| .. _auth-surl: | | | |
|
| 341 |
| | | | |
|
| 296 | 342 |
| auth.surl | The URL of the server that Metacat should use for secure authentication. | ldap://ldap.ecoinformatics.org:389/ | |
| 297 | 343 |
| | | | |
| 298 | 344 |
| | Default Value: ldap://ldap.ecoinformatics.org:389/ | | |
| 299 | 345 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 346 |
| .. _auth-base: | | | |
|
| 347 |
| | | | |
|
| 300 | 348 |
| auth.base | The base part of the distinguished name that Metacat uses for authentication. | dc=ecoinformatics,dc=org | |
| 301 | 349 |
| | | | |
| 302 | 350 |
| | Default Value: dc=ecoinformatics,dc=org | | |
| 303 | 351 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 352 |
| .. _auth-allowedSubmitters: | | | |
|
| 353 |
| | | | |
|
| 304 | 354 |
| auth.allowedSubmitters | A colon delimited list of users who should be allowed to submit documents | uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org | |
| 305 | 355 |
| | to Metacat. If no value is specified, all users will be | | |
| 306 | 356 |
| | allowed to submit documents. | | |
| 307 | 357 |
| | | | |
| 308 | 358 |
| | Default Value: (none) | | |
| 309 | 359 |
+-----------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------+ |
| 360 |
| .. _auth-deniedSubmitters: | | | |
|
| 361 |
| | | | |
|
| 310 | 362 |
| auth.deniedSubmitters | A colon delimited list of users who should NOT be allowed to | uid=youruser,o=NCEAS,dc=ecoinformatics,dc=org | |
| 311 | 363 |
| | submit documents. If no value is specified, all users will be allowed to | | |
| 312 | 364 |
| | submit documents. | | |
Also available in: Unified diff
correct the metacat.properties help anchors.