Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property NameDescriptionDefault ValueConstraints
fcrepo.homeThe 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 (specified 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.tmpdirThis 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.external.content.allowedThis 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 option results in every change to Fedora resources either:

  • false - being persisted in the OCFL "mutable-head" extension
  • true - being persisted as a new OCFL version.

See here for more details.

truetrue, false
fcrepo.session.timeoutThis sets the duration (in milliseconds) for which a transaction will stay active before auto-rolling back.180,000ms (3 minutes)
fcrepo.velocity.runtime.logThe HTML template code uses Apache Velocity, which generates a runtime log called velocity.log.<fcrepo.home/logs/velocity.log>
fcrepo.properties.managementControls if updating server managed triples is allowed in user RDF. By default, it is not allowed. See here for more details.strictstrict, relaxed
fcrepo.metrics.enableControls if applications metrics are collected and emitted. See the metrics page for more information.falsetrue, false
fcrepo.event.threadsControls the number of threads that are used to process events on Fedora's internal event bus. This is used for asynchronous tasks like search indexing and emitting JMS messages.1> 0
Auth (more info)
fcrepo.auth.enabledSpecifies if authorization should be enabled. Note, this does not disable authentication.truetrue, false
fcrepo.auth.principal.header.enabledEnables the principal provider that extracts a principal out of a specified HTTP header.falsetrue, false
fcrepo.auth.principal.header.nameThe name of the header to extract a principal from.some-header
fcrepo.auth.principal.header.separatorThe separator in the principal header.,
fcrepo.auth.principal.roles.enabledEnables the principal provider that uses Tomcat roles.falsetrue, false
fcrepo.auth.principal.roles.listThe list of Tomcat roles. This should be a comma separated list of roles.tomcat-role-1,tomcat-role-2comma separated list
fcrepo.auth.principal.delegate.enabledEnables the delegate principal provider that allows a principle to be specified using the On-Behalf-Of header.truetrue, false
fcrepo.auth.webac.authorizationSpecifies the path to the ACL to use for the Fedora repository root resource. Use this to override the default ACL.

fcrepo.auth.webac.userAgent.baseUriSpecifies the base URI that should be prepended to the user agent

fcrepo.auth.webac.groupAgent.baseUriSpecifies the base URI that should be prepended to the group agent

Database (more info)
fcrepo.db.url

This parameter allows you to set the database connection url. In general the format is as follows:

Code Block
jdbc:<database_type>://<database_host>:<database_port>/<database_name> 

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: 


PostgresQL: jdbc:postgresql://localhost:5432/fcrepo

MariaDB:  jdbc:mariadb://localhost:3306/fcrepo

MySQL:  jdbc:mysql://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.userThe database username None - H2 doesn't require it
fcrepo.db.passwordThe database passwordNone - H2 doesn't require it

fcrepo.db.connection.checkout.timeout

The amount of time to wait before assuming checkout failed in milliseconds10000

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. truetrue, false

Anchor
ocfl
ocfl
OCFL

fcrepo.ocfl.rootSets the root directory of the OCFL.  <fcrepo.home>/data/ocfl-root
fcrepo.ocfl.tempSets the temp directory used by OCFL.  <fcrepo.home>/data/ocfl-temp
fcrepo.ocfl.stagingSets the staging directory used by OCFL. <fcrepo.home>/data/ocfl-staging
fcrepo.persistence.defaultDigestAlgorithmThe digest algorithm used by OCFL, also used to calculate resource checksums. Changing the digest algorithm to sha256 will reduce the amount disk overhead consumed by OCFL related metadata.sha512sha256, sha512
fcrepo.ocfl.unsafe.write.enabledWhen this option is enabled, files are stored in OCFL objects without calculating their digest again. This eliminates a redundant digest calculation, speeding up writes, at the cost of less safe write operations. If there is a bug in Fedora that results in it calculating incorrect digests, then there is a risk that it will create corrupted OCFL objects with this option enabled.falsetrue,false

fcrepo.ocfl.reindex.failOnError

Indicate whether reindexing should fail on error.truetrue, false

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. By default it will attempt to guess a reasonable number of threads based on the CPU characteristics-1
fcrepo.rebuild.on.startA boolean flag that when set to true directs Fedora to rebuild internal Fedora indices on start.falsetrue,false
fcrepo.rebuild.validation.fixityDetermines if file fixity should be checked as part of rebuild validation. This may take a long time.falsetrue, false

fcrepo.storage

The type of backend storage formatocfl-fsocfl-fs, ocfl-s3
JMS

fcrepo.jms.enabled

Specifies if JMS should be enabled.truetrue, false
fcrepo.jms.destination.typeSpecifies if a JMS topic or queue should be used. Queues are recommended for production environments.topictopic, queue
fcrepo.jms.destination.nameThe name of the topic/queuefedora
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.configurationSpecifies the path to the xml configuration of your ActiveMQ service. classpath:/config/activemq.xml
fcrepo.activemq.directoryContains the reliable messaging information maintained by ActiveMQ.<fcrepo.home>/data/ActiveMQ/kahadb
fcrepo.jms.baseUrlThis 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>
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. This may also be configured using environment variables or an AWS credentials file

fcrepo.aws.secret-key

The AWS secret key. This may also be configured using environment variables or an AWS credentials file

fcrepo.s3.endpointThe URL to the S3 endpoint. Only needs to be set if you are using a non-standard endpoint

fcrepo.s3.path.style.accessIf path style S3 access should be enabled. Some non-AWS S3 implementations only support path style access.falsetrue, false
fcrepo.ocfl.s3.db.enabledDetermines if the OCFL client caches OCFL object inventories in a database table. This is intended to speed things up a little and solve the eventual consistency problem. Amazon S3 is now strongly consistent, so this table is not strictly necessary, but non-AWS implementations may or may not be. When enabled, Postgres must be used.truetrue, false

...