Page History

...

The Fedora 4 web-application supports several deploy-time, system-level configuration options. These configuration elements are set via the definition of System Properties.

Deployments

Four means of deploying Fedora 4 have been verified

...

JAVA_OPTS="${JAVA_OPTS} -Dfcrepo.modeshape.configuration=classpath:/config/file-simple/repository.json -Dfcrepo.home=/mnt/fedora-data"

...

set CATALINA_OPTS=%CATALINA_OPTS% -Dfcrepo.ispnmodeshape.repo.CacheDirPathconfiguration=F:\fedora\cache

Caused by: org.fusesource.leveldbjni.internal.NativeDB$DBException: IO error: F:\apache-tomcat-7.0.50-windows-x64\apache-tomcat-7.0.50\bin\fcrepo4-data\fcrepo.ispn.repo.CacheDirPath\data\MANIFEST-000002: The handle is invalid.classpath:/config/file-simple/repository.json

Anchor
jetty jetty

Jetty 9

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

...

JAVA_OPTIONS="${JAVA_OPTIONS} -Dfcrepo.modeshape.configuration=classpath:/config/file-simple/repository.json -Dfcrepo.home=/mnt/fedora-data"

...

--exec
-Dfcrepo.home=/mnt/fedora-data
-Dfcrepo.modeshape.configuration=classpath:/config/file-simple/repository.json

Maven jetty:run

System Properties can be set when using the Maven jetty:run plugin by passing them per the example below:

mvn -Dfcrepo.home=/mnt/fedora-data -Dfcrepo.modeshape.configuration=classpath:/config/file-simple/repository.json 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:

...

There are a number of configuration elements that can be optionally be set when starting the Fedora 4 web-application. No configuration elements are required to be set, as they all default values ( 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 and Infinispan 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.

fcrepo.modeshape.configuration=<classpath:/config/repository.json | file:/path/to/repository.json>

This specifies the configuration for the underlying Modeshape repository and is required to be set. See other available options for this value within the source tree. The default file is Example repository.json configurations are located within the WAR file within sub-directories under WEB-INF/classes/config.

fcrepo.infinispan.cache_configuration=<config/infinispan.xml>

This specifies the underlying Infinispan cache configuration. This value has a tested default set in the modeshape.json file mentioned above; and therefore, can usually be left as is. The default file is located within the WAR file under WEB-INF/classes/configNote: this configuration file must be readable by the servlet container process.

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.

Anchor
modeispn modeispn

Modeshape

...

The Modeshape and Infinispan 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 and infinispan.xml files  files specified above. Those files can be browsed in the source tree in:

• the ModeShape configuration directories and,the Infinispan configuration directories.

Some common elements for Modeshape and Infinispan 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 "fcrepo4-data" in the application's current working directory. There will then be several directories within "fcrepo4-data" 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:

No Format
fcrepo.ispn.repo.CacheDirPath

Contains the serialized repository resource properties.

 

No Format
fcrepo.modeshape.index.locationdirectory

Contains the internal Lucene index used by Modeshape/Admin Search.

...

No Format
fcrepo.activemq.dirdirectory

Contains the reliable messaging information maintained by ActiveMQ.

...

Contain JBoss JTA transaction engine artifacts.

Configuration Chain

The standard configuration chain is as follows:

1. fcrepo4/fcrepo-webapp/src/main/webapp/WEB-INF/web.xml contains a context-param element with param-name "contextConfigLocation".  The param-value points to a repository.xml which includes either the default fcrepo-config.xml or your spring configuration file (as defined by the fcrepo.spring.configuration property.
2. Your spring configuration file contains a property repositoryConfiguration defining the location of your repository.json
3. fedora-node-types.cnd is defined in repository.json