Application Configuration

The Fedora web-application supports several deploy-time, system-level configuration options. These configuration elements are set via the definition of System Properties.can be set using a properties file or through system properties.

Deployments

Four means of deploying Fedora have been verified

...

set CATALINA_OPTS=%CATALINA_OPTS% -Dfcrepo.home=/mnt/fedora-data

Reverse Proxy

If you have a reverse proxy for serving HTTPS that uses Tomcat's HTTP port, you will also need to set up a RemoteIPValve in your server.xml in order for Tomcat to rewrite links with HTTPS.

To do this you will first need to make sure the X-Forwarded-Proto header is set in your server config (example with Apache):

<VirtualHost *:443>
    RequestHeader set X-Forwarded-Proto "https"
    ServerName dummy-host.example.com

    SSLEngine on
    SSLCertificateFile  /etc/ssl/certs/localhost.crt
    SSLCertificateKeyFile /etc/ssl/private/localhost.key

    ProxyPreserveHost On
    ProxyRequests Off
    ProxyPass / http://localhost:8080/
    ProxyPassReverse / http://localhost:8080/

    DocumentRoot "/opt/fedora/apache-tomcat-8.5.66/webapps/fcrepo-webapp"
</VirtualHost>

Then you will need to add a Valve to the localhost Engine in Tomcat's server.xml:

        <Valve className="org.apache.catalina.valves.RemoteIpValve"
               protocolHeader="X-Forwarded-Proto" />

Anchor
jetty jetty

Jetty 9

On Debian Linux systems, one way of setting System Properties is to update the following file:

...

mvn -Dfcrepo.home=/mnt/fedora-data jetty:run

One-Click Run

If the One-Click Run is started from the command line, System Properties can be passed in per the example below:

java -Dfcrepo.home=/mnt/fedora-data -jar fcrepo-webapp-jetty-console.war 

...

There are a number of configuration elements that can be optionally be set when starting the Fedora web-application, noted below within brackets: <>. The only configuration element that is required to be set is "fcrepo.modeshape.configuration".

fcrepo.home=<cwd/fcrepo4-data>

This can be set to a path (relative to the current working directory or absolute) to which Fedora repository content will be written.  Any of the Modeshape configuration options below will default to being within this folder if unset or if set to a relative path.  If unset, content will be put in the "fcrepo4-data" directory within the current working directory.

fcrepo.spring.configuration=<classpath:/config/spring/fcrepo-config.xml | file:/path/to/fcrepo-config.xml>

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.

java.io.tmpdir=</tmp on Linux, $TMPDIR on MacOSX, and %TEMP% on Windows>

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.

fcrepo.jms.baseUrl=<http://localhost:8080/fcrepo/rest>

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.

Note: If you have multiple instances of Fedora running, the following system properties must be set to avoid messaging port conflicts:

fcrepo.dynamic.jms.port=<default-of-61616>
fcrepo.dynamic.stomp.port=<default-of-61613>

This specifies the ports used by the embedded JMS-based message broker, both for OpenWire and STOMP protocols.

fcrepo.velocity.runtime.log=<$fcrepo.home/velocity.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.external.content.allowed=</path/to/allowed.txt>

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.

-Dfcrepo.autoversioning.enabled=false

This results in every change to Fedora resources being persisted in the OCFL "mutable-head" extension, as opposed in a new OCFL version. (default is "true")

    <!-- Containment Index DB -->
    <bean id="containmentIndexDataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
      <property name="driverClassName" value="org.h2.Driver" />
      <property name="url" value="jdbc:h2:mem:index" />
    </bean>

Within Fedora's fcrepo-config.xml file, the value of "url" can be changed to support a wide range of connection modes and connection settings. Reference

-Dfcrepo.session.timeout=<milliseconds>

This sets the duration for which a transaction will stay active before auto-rolling back. Defaults to 180000 ms, or 3 minutes

-Dfcrepo.persistence.defaultDigestAlgorithm=[sha512|sha256]

This sets the default digest algorithm on ingested binary resources (default: sha512)

...

The OCFL persistence configurations mentioned above have a number of more detailed configuration elements that can optionally be set. To see exactly which elements are available to be set, inspect the repository.json files specified above. Those files can be browsed in the source tree in:

• the configuration directories

Some common elements relate to the directories in which application information is persisted. As mentioned above, if no fcrepo.home property is set then application information will be persisted under the directory "/tmp". There will then be several directories within "/tmp" that are named by default with the name of the property that can be set to configure each of those directories.

Below are some common examples of these directories: 

fcrepo.ocfl.storage.root.dir
fcrepo.ocfl.staging.dir
fcrepo.ocfl.work.dir

Contains the OCFL storage root.

fcrepo.activemq.directory

Contains the reliable messaging information maintained by ActiveMQ.

Configuration Chain

The standard configuration chain is as follows:

...

Click here for a complete list of configurable properties.