Skip to main content

Mounting Files

The Frank!Framework container uses several well-known directories and files. You can mount these to provide your own content.

Directories

DirectoryDescription
/opt/frank/configurationsFor configurations. May contain per-configuration directories or a JAR containing those directories. If Configuration.xml is not at <configurationName>/Configuration.xml, define configurations.<configurationName>.configurationFile with the path to Configuration.xml. Configurations are loaded automatically by default (configurations.directory.autoLoad=true).
/opt/frank/resourcesFor application-wide properties. May contain files or a JAR with all files. Minimum required properties are instance.name and configurations.names, which can also be set using environment variables.
/opt/frank/testtoolLarva tests included in the image.
/opt/frank/testtool-extLarva tests mounted from the environment.
/opt/frank/secretsCredential storage (credentials.properties is read by default). See Secrets.
/opt/frank/driversDriver JARs. See Drivers.
/opt/frank/pluginsPlugin JARs.
/usr/local/tomcat/logsLog directory.

To mount additional directories, add volumes or watch entries to the frankframework service in compose.yaml.

Example with volumes:

services:
frankframework:
...
volumes:
- ./resources/:/opt/frank/resources

Example with file watch:

develop:
watch:
- action: sync
path: ./resources
target: /opt/frank/resources

The image runs Tomcat as tomcat:tomcat (UID=2000, GID=2000). Ensure mounted or copied files are owned appropriately.

Files

FileDescription
/opt/frank/resources/resources.ymlMount or copy your resources.yml. Use host.docker.internal to reach the host for local testing. Changes require restart (for watch mode, use sync+restart).
/usr/local/tomcat/conf/server.xmlMount or copy your server.xml. Replace as needed to secure your Tomcat setup.
/usr/local/tomcat/conf/catalina.propertiesContains default framework values. Do not replace it. Use environment variables or append values instead.