...
| Anchor | ||||
|---|---|---|---|---|
|
Two ways of passing configuration: property file or command-line argument
Before we enumerate the configurable properties and their defaults it should be noted that there are two ways of passing this configuration to your Fedora instance. As noted above you can use the -D<param.name>=<param.value> syntax. Optionally you can pass all the parameters at once by putting them in a java properties file and passing the path of the file as a command line argument. For example, to pass two parameters at once using a property file, by file simply create a file with any arbitrary name and path such as "my_fcrepo.properties". Then add your parameters as you would in any Java properties file, like this:
| Code Block |
|---|
# add any number of properties below
fcrepo.home: my_fcrepo_home_directory
fcrepo.autoversioning.enabled: true
|
Then pass these parameters to Fedora like this:
| Code Block |
|---|
java -Dfcrepo.config-file=my_fcrepo.properties -jar fcrepo-webapp-6.0.0-SNAPSHOT-jetty-console.jar |
IMPORTANT NOTE ON PROPERTY PRECEDENCE
You may pass parameters simultaneously via the command-line params as well as by property file. However, please keep in mind that command-line parameter values will overwrite any values defined in your properties file. So using the above mentioned property file as an example
| Code Block |
|---|
java -Dfcrepo.config-file=my_fcrepo.properties -jar fcrepo-webapp-6.0.0-SNAPSHOT-jetty-console.jar |
will have an fcrepo.home value of "my_fcrepo_home_directory" whereas
| Code Block |
|---|
java -Dfcrepo.home=overridden_fcrepo_home -Dfcrepo.config-file=my_fcrepo.properties -jar fcrepo-webapp-6.0.0-SNAPSHOT-jetty-console.jar |
will have an fcrepo.home value of "overridden_fcrepo_home".
Table of Configurable Properties
There are a number of configuration elements that can be optionally be set when starting the Fedora webFedora web-application, noted below within brackets: <>.
| Property Name | Description | Default Value | Constraints |
|---|---|---|---|
| fcrepo.config-file | The path to a properties file containing any property name value pair specified below. |
...
| If the file does not exist, Fedora will silently ignore it. | None |
...
| fcrepo.home |
...
| The home directory for all Fedora generated output and state. Unless otherwise specified, all logs, metadata, binaries, and internally generated indexes, etc. | <cwd/fcrepo-home> |
...
fcrepo.spring.configuration | The path to the spring configuration. While it is generally not recommended to use this option, in some cases you may need to make adjustments to the default spring configuration. This can be set to a path (relative to the current working directory or absolute) to which Fedora repository content will be written. |
...
|
...
...
...
...
This specifies the location of the spring context configuration for the Fedora application it defaults to a provided configuration. For more configuration options review the fcrepo-webapp-plus supplied spring configuration.
...
| xml |
| java.io.tmpdir |
...
| This specifies the directory for writing temp files. You may need to set this property to a larger disk/filesystem to upload large files, particularly on Linux where /tmp is sometimes on a small partition. | </tmp on Linux, $TMPDIR on MacOSX, and %TEMP% on Windows> | ||
| fcrepo.jms.baseUrl | This specifies the baseUrl to use when generating JMS messages. You can specify the hostname with or without port and with or without path. If your system is behind a NAT firewall you may need this to avoid your message consumers trying to access the system on an invalid port. If this system property is not set, the host, port and context from the user's request will be used in the emitted JMS messages. | <http://localhost:8080/fcrepo/rest> | |
| No Format |
|---|
fcrepo.jms.baseUrl=<http://localhost:8080/fcrepo/rest> |
...