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 |
|---|
java -Dfcrepo.config.file=my_fcrepo.properties -jar fcrepo-webapp-<version>-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
...
will have an fcrepo.home value of "overridden_fcrepo_home".
Table of Configurable Properties
There are a number of configuration elements that can optionally be set when starting the Fedora web-application, noted below within brackets: <>.
| fcrepo4 references purged from pom files? | Property Name | Description | Default Value | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 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.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. Important note: if you create the properties file in the default location (specfied in the next column) know that any definition of fcrepo.home in that file will be ignored. The fcrepo.home property will be read from the properties file only when the following two conditions are present: 1) you are using the -Dfcrepo.config.file=... option and 2) you have not specified -Dfcrepo.home=... | <fcrepo.home>/config/fcrepo.properties | ||||||||
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. | <classpath:/config/spring/fcrepo-config.xml> | file:/path/to/fcrepo-config.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.dynamic.jms.port | This specifies the ports used by the embedded JMS-based message broker for OpenWire protocol. Note: If you have multiple instances of Fedora running, this property must be set to avoid messaging port conflicts. | 61616 | ||||||||
| fcrepo.dynamic.stomp.port | This specifies the ports used by the embedded JMS-based message broker for STOMP protocol. Note: If you have multiple instances of Fedora running, this property must be set to avoid messaging port conflicts. | 61613 | ||||||||
| fcrepo.activemq.directory | Contains the reliable messaging information maintained by ActiveMQ. | <fcrepo.home>/data/ActiveMQ/kahadb | ||||||||
| fcrepo.external.content.allowed | This provides the path to a file defining a list of allowed external binary content paths. If this parameter is not provided, then clients will be disallowed from creating external binary resources. See the external content allowed paths configuration for more details. | </path/to/allowed.txt> | ||||||||
| fcrepo.autoversioning.enabled | This results in every change to Fedora resources being persisted in the OCFL "mutable-head" extension, as opposed in a new OCFL version. | true | ||||||||
| Database (more info) | ||||||||||
| fcrepo.db.url | This parameter allows you to set the database connection url. In general the format is as follows:
Fedora currently supports H2, PostgresQL 12.3, MariaDB 10.5.3, and MySQL 8.0 So using the default ports for the supported databases here are the values we typically use:
MariaDB: jdbc:mariadb://localhost:3306/fcrepo If you wish to configure h2, there are a variety of options detailed in the H2 Reference docs. | By default Fedora uses an embedded H2 database. | ||||||||
| fcrepo.db.user | The database username | None - H2 doesn't require it | ||||||||
| fcrepo.db.password | The database password | None - H2 doesn't require it | ||||||||
fcrepo.db.connection.checkout.timeout | The amount of time to wait before assuming checkout failed in milliseconds | 10000 | ||||||||
fcrepo.db.connection.idle.test.period | The amount of time in seconds between idle connection tests. | 300 | ||||||||
fcrepo.db.connection.test.on.checkout | Specifies whether or not to test a database connection on checkout. | true | ||||||||
| Messaging | ||||||||||
| 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> | ||||||||
fcrepo.velocity.runtime.log | The HTML template code uses Apache Velocity, which generates a runtime log called velocity.log. By default this is placed inside fcrepo.home, but it is possible to override the location to have it written to an alternate location. | <$fcrepo.home/velocity.log> | ||||||||
| Persistence | ||||||||||
| fcrepo.session.timeout | This sets the duration for which a transaction will stay active before auto-rolling back. Defaults to 180000 ms, or 3 minutes. | 180000 | ||||||||
fcrepo.persistence.defaultDigestAlgorithm | This sets the default digest algorithm on ingested binary resources. Valid values: [sha512|sha256] | sha512 | ||||||||
| ||||||||||
| fcrepo.ocfl.root | Sets the root directory of the OCFL. | <fcrepo.home>/data/ocfl-root | ||||||||
| fcrepo.ocfl.temp | Sets the temp directory used by OCFL. | <fcrepo.home>/data/ocfl-temp | ||||||||
| fcrepo.ocfl.staging | Sets the staging directory used by OCFL. | <fcrepo.home>/data/ocfl-staging | ||||||||
fcrepo.ocfl.reindex.failOnError | Indicate whether reindexing should fail on error. | true | ||||||||
fcrepo.ocfl.reindex.batchSize | The size of batches of OCFL ids used by the reindexer. | 100 | ||||||||
fcrepo.ocfl.reindex.threads | The number of threads to be used by the reindexer. | -1 | ||||||||
fcrepo.storage | The type of backend storage format: Valid values: ocfl-fs, ocfl-s3 | ocfl-fs | ||||||||
| OCFL/S3 Configuration (more info) | ||||||||||
fcrepo.ocfl.s3.bucket | The s3 bucket to host the OCFL. | |||||||||
fcrepo.ocfl.s3.prefix | A prefix can be provided to partition the S3 bucket so that Fedora uses only a portion of the bucket. | |||||||||
fcrepo.aws.region | The default region used by the client. The region codes found in the table provided by Amazon's documentation are all available, such as "us-east-2", "eu-west-1", etc. | us-east-1 | ||||||||
fcrepo.aws.access-key | The AWS access key | |||||||||
fcrepo.aws.secret-key | The AWS secret key | |||||||||
Other properties
The following properties are only configurable via the command-line using the -Dname=value syntax:
Parallel stream processing
| Code Block |
|---|
fcrepo.streaming.parallel:false |
If you are running Fedora on a multiprocessor machine you can level parallel processing across single requests by turning this option on. Parallel processing of streams can boost the retrieval speeds of the RDF associated with objects with large numbers of inlinks (ie dependent objects with memberOf associations). Enabling this option in conjunction with increasing with cacheSize parameter in your repository.json file can boost retrieval speeds significantly.
Allowing user updates to certain server managed triples
You can relax certain restrictions on updating some server managed triples using the following setting:
...
For details please refer to the following article: How to allow user-updates to certain server managed triplesUpdating Server Managed Triples.
Setting the default digest algorithm
By default the digest algorithm is SHA-512. To change it to SHA-256 use the following setting
...