Project

General

Profile

« Previous | Next » 

Revision 7425

correct the metacat.properties help anchors.

View differences:

lib/metacat.properties.metadata.xml
43 43
		<description>
44 44
			Default skin type. Not shown on config page but we want it to backup.
45 45
		</description>
46
		<helpFile>docs/metacat-properties.html#application.default-style</helpFile>
46
		<helpFile>docs/metacat-properties.html#application-default-style</helpFile>
47 47
	</config>
48 48

  
49 49
	<config>
......
54 54
		<description>
55 55
			Name of database user to own all tables.
56 56
		</description>
57
		<helpFile>docs/metacat-properties.html#database.user</helpFile>
57
		<helpFile>docs/metacat-properties.html#database-user</helpFile>
58 58
	</config>
59 59

  
60 60
	<config>
......
64 64
		<index>2</index>
65 65
		<fieldType>password</fieldType>
66 66
		<description>Password for database user.</description>
67
		<helpFile>docs/metacat-properties.html#database.password</helpFile>
67
		<helpFile>docs/metacat-properties.html#database-password</helpFile>
68 68
	</config>
69 69

  
70 70
	<config>
......
86 86
			<value>sqlserver</value>
87 87
		</option -->
88 88
		<description>What kind of database is running.</description>
89
		<helpFile>docs/metacat-properties.html#database.type</helpFile>
89
		<helpFile>docs/metacat-properties.html#database-type</helpFile>
90 90
	</config>
91 91

  
92 92
	<config>
......
111 111
			Which driver is required. This should conform to your
112 112
			database type.
113 113
		</description>
114
		<helpFile>docs/metacat-properties.html#database.driver</helpFile>
114
		<helpFile>docs/metacat-properties.html#database-driver</helpFile>
115 115
	</config>
116 116

  
117 117
	<config>
......
136 136
			Which adapter is required. This should conform to your
137 137
			database type.
138 138
		</description>
139
		<helpFile>docs/metacat-properties.html#database.adapter</helpFile>
139
		<helpFile>docs/metacat-properties.html#database-adapter</helpFile>
140 140
	</config>
141 141

  
142 142
	<config>
......
145 145
		<group>1</group>
146 146
		<index>6</index>
147 147
		<description>Database connection string.</description>
148
		<helpFile>docs/metacat-properties.html#database.connectionURI</helpFile>
148
		<helpFile>docs/metacat-properties.html#database-connectionURI</helpFile>
149 149
	</config>
150 150

  
151 151
	<config>
......
156 156
		<description>
157 157
			Name of the server where Metacat will be available.
158 158
		</description>
159
		<helpFile>docs/metacat-properties.html#server.name</helpFile>
159
		<helpFile>docs/metacat-properties.html#server-name</helpFile>
160 160
	</config>
161 161

  
162 162
	<config>
......
167 167
		<description>
168 168
			Non secure port where Metacat will be available.
169 169
		</description>
170
		<helpFile>docs/metacat-properties.html#server.httpPort</helpFile>
170
		<helpFile>docs/metacat-properties.html#server-httpPort</helpFile>
171 171
	</config>
172 172

  
173 173
	<config>
......
178 178
		<description>
179 179
			Secure port where Metacat will be available.
180 180
		</description>
181
		<helpFile>docs/metacat-properties.html#server.httpSSLPort</helpFile>
181
		<helpFile>docs/metacat-properties.html#server-httpSSLPort</helpFile>
182 182
	</config>
183 183
	
184 184
	<config>
......
189 189
		<description>
190 190
			The directory where the application is deployed.
191 191
		</description>
192
		<helpFile>docs/metacat-properties.html#application.deployDir</helpFile>
192
		<helpFile>docs/metacat-properties.html#application-deployDir</helpFile>
193 193
	</config>
194 194
	
195 195
	<config>
......
198 198
		<group>3</group>
199 199
		<index>1</index>
200 200
		<description>Allowed Submitters</description>
201
		<helpFile>docs/metacat-properties.html#auth.allowedSubmitters</helpFile>
201
		<helpFile>docs/metacat-properties.html#auth-allowedSubmitters</helpFile>
202 202
	</config>
203 203

  
204 204
	<config>
......
207 207
		<group>3</group>
208 208
		<index>2</index>
209 209
		<description>Denied Submitters</description>
210
		<helpFile>docs/metacat-properties.html#auth.deniedSubmitters</helpFile>
210
		<helpFile>docs/metacat-properties.html#auth-deniedSubmitters</helpFile>
211 211
	</config>
212 212

  
213 213
	<config>
......
219 219
			Name of the context under which Metacat will run. This is
220 220
			the directory in which the Metacat war file is deployed.
221 221
		</description>
222
		<helpFile>docs/metacat-properties.html#application.context</helpFile>
222
		<helpFile>docs/metacat-properties.html#application-context</helpFile>
223 223
	</config>
224 224

  
225 225
	<config>
......
231 231
			Location of KNB website. Usually left as
232 232
			http://knb.ecoinformatics.org
233 233
		</description>
234
		<helpFile>docs/metacat-properties.html#application.knbSiteURL</helpFile>
234
		<helpFile>docs/metacat-properties.html#application-knbSiteURL</helpFile>
235 235
	</config>
236 236

  
237 237
	<config>
......
243 243
			Where to store data. This should be some location outside
244 244
			the knb install direcories.
245 245
		</description>
246
		<helpFile>docs/metacat-properties.html#application.datafilepath</helpFile>
246
		<helpFile>docs/metacat-properties.html#application-datafilepath</helpFile>
247 247
	</config>
248 248

  
249 249
	<config>
......
255 255
			Where to store inline data. This should be some location
256 256
			outside the knb install direcories.
257 257
		</description>
258
		<helpFile>docs/metacat-properties.html#application.inlinedatafilepath</helpFile>
258
		<helpFile>docs/metacat-properties.html#application-inlinedatafilepath</helpFile>
259 259
	</config>
260 260
	
261 261
	<config>
......
267 267
			Where to store metadata documents. This should be some location
268 268
			outside the knb install direcories.
269 269
		</description>
270
		<helpFile>docs/metacat-properties.html#application.documentfilepath</helpFile>
270
		<helpFile>docs/metacat-properties.html#application-documentfilepath</helpFile>
271 271
	</config>
272 272
	
273 273
	<config>
......
281 281
			set to a directory that is dedicated solely to temporary data, 
282 282
			since the contents may be deleted programatically.&lt;/font&gt;
283 283
		</description>
284
		<helpFile>docs/metacat-properties.html#application.tempDir</helpFile>
284
		<helpFile>docs/metacat-properties.html#application-tempDir</helpFile>
285 285
	</config>
286 286
	
287 287
	<config>
......
292 292
		<description>
293 293
			The directory where replication log should be located.
294 294
		</description>
295
		<helpFile>docs/metacat-properties.html#replication.logdir</helpFile>
295
		<helpFile>docs/metacat-properties.html#replication-logdir</helpFile>
296 296
	</config>
297 297
	
298 298
	<!-- START Data Manager configuration -->
......
304 304
		<description>
305 305
			Host or IP of database server
306 306
		</description>
307
		<helpFile>docs/metacat-properties.html#datamanager.server</helpFile>
307
		<helpFile>docs/metacat-properties.html#datamanager-server</helpFile>
308 308
	</config>
309 309
	
310 310
	<config>
......
315 315
		<description>
316 316
			Name of the data manager database
317 317
		</description>
318
		<helpFile>docs/metacat-properties.html#datamanager.database</helpFile>
318
		<helpFile>docs/metacat-properties.html#datamanager-database</helpFile>
319 319
	</config>
320 320
	
321 321
	<config>
......
326 326
		<description>
327 327
			Name of database user to own all tables.
328 328
		</description>
329
		<helpFile>docs/metacat-properties.html#datamanager.user</helpFile>
329
		<helpFile>docs/metacat-properties.html#datamanager-user</helpFile>
330 330
	</config>
331 331

  
332 332
	<config>
......
336 336
		<index>4</index>
337 337
		<fieldType>password</fieldType>
338 338
		<description>Password for database user.</description>
339
		<helpFile>docs/metacat-properties.html#datamanager.password</helpFile>
339
		<helpFile>docs/metacat-properties.html#datamanager-password</helpFile>
340 340
	</config>
341 341
	<!-- END Data Manager configuration -->
342 342

  
......
347 347
		<group>5</group>
348 348
		<index>1</index>
349 349
		<description>Comma-separated list of fully-qualified class names that implement MetacatHandlerPlugin interface</description>
350
		<helpFile>docs/metacat-properties.html#plugin.handlers</helpFile>
350
		<helpFile>docs/metacat-properties.html#plugin-handlers</helpFile>
351 351
	</config>
352 352
	
353 353
	<!-- DataONE configuration -->
lib/auth.properties.metadata.xml
25 25
		<index>1</index>
26 26
		<required>true</required>
27 27
		<description>Authentication Class.</description>
28
		<helpFile>docs/metacat-properties.html#auth.class</helpFile>
28
		<helpFile>docs/metacat-properties.html#auth-class</helpFile>
29 29
	</config>
30 30
	
31 31
	<config>
......
35 35
		<index>2</index>
36 36
		<required>true</required>
37 37
		<description>Authentication Server URL.</description>
38
		<helpFile>docs/metacat-properties.html#auth.url</helpFile>
38
		<helpFile>docs/metacat-properties.html#auth-url</helpFile>
39 39
	</config>
40 40

  
41 41
	<config>
......
45 45
		<index>3</index>
46 46
		<required>true</required>
47 47
		<description>Authentication Secure Server URL.</description>
48
		<helpFile>docs/metacat-properties.html#auth.surl</helpFile>
48
		<helpFile>docs/metacat-properties.html#auth-surl</helpFile>
49 49
	</config>
50 50
	
51 51
	<config>
......
55 55
		<index>4</index>
56 56
		<required>true</required>
57 57
		<description>Base part of Distinguished Name that Metacat uses for authentication.</description>
58
		<helpFile>docs/metacat-properties.html#auth.base</helpFile>
58
		<helpFile>docs/metacat-properties.html#auth-base</helpFile>
59 59
	</config>
60 60

  
61 61
	<config>
......
69 69
			&lt;font color="red"&gt; Note: this must be set to a username or
70 70
			group that you belong to in order to continue with 
71 71
			configuration&lt;/font&gt;.</description>
72
		<helpFile>docs/metacat-properties.html#auth.administrators</helpFile>
72
		<helpFile>docs/metacat-properties.html#auth-administrators</helpFile>
73 73
		<isRequired>true</isRequired>
74 74
	</config>
75 75
	
docs/user/metacat/source/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