Skip to content

EntryStore installation

EntryStore 6.x runs as a self-contained Spring Boot application with an embedded web server. It is distributed as an executable jar and as a Docker image. EntryStore 5.x was deployed in a servlet container; its instructions are kept in the 5.x tabs below. When moving an instance from 5.x to 6.x, see Upgrading from 5.x to 6.x.

Prerequisites

  • Java 25 (not needed when running the Docker image)
  • An external Solr 10 server, if search is used (entrystore.solr=on)
  • A Linux-based operating system is recommended
  • Java 21
  • A servlet container such as Apache Tomcat, or the bundled Jetty distribution
  • Maven 3, if EntryStore is built from source

Installation

Executable jar

The jar can be downloaded from entrystore.org/download/, together with a signed SHA-256 checksum.

EntryStore reads its configuration from a file named entrystore.properties in the current working directory (see Configuration). Start it from the directory that contains this file:

java -jar entrystore-<version>.jar

The application listens on port 8080 under the context path /store, i.e. at http://host:8080/store/. Both can be changed in entrystore.properties with server.port and server.servlet.context-path.

A configuration file in another location can be passed with --spring.config.import=file:/path/to/entrystore.properties. Single settings can be overridden on the command line, e.g. --entrystore.solr.url=https://solr.domain.tld/solr/entrystore. JVM options such as the heap size are best passed in the environment variable JAVA_TOOL_OPTIONS, e.g. JAVA_TOOL_OPTIONS="-Xmx2g".

Docker

The Docker image metasolutions/entrystore:<version> is available on Docker Hub. It runs EntryStore as an unprivileged user (uid/gid 2000) in /srv/entrystore and exposes port 8080.

docker run -p 8080:8080 \
  -v $(pwd)/entrystore.properties:/srv/entrystore/entrystore.properties \
  -v entrystore-data:/srv/entrystore/data \
  metasolutions/entrystore:<version>

The configuration is provided in one of these ways:

  • Mount the file at /srv/entrystore/entrystore.properties, as in the example above.
  • Set the environment variable ENTRYSTORE_CONFIG_URI to an https:// or file:// URL; the file is fetched or copied when the container starts. Plain http:// is rejected.
  • Pass single settings as arguments after the image name, e.g. --entrystore.baseurl.folder=https://domain.tld/store/. They override values from the file.

Persistent data is kept under /srv/entrystore/data, which should be a volume or bind mount. The image prepares these subfolders, which the paths in entrystore.properties should point to:

Path Content
/srv/entrystore/data/store Repository (entrystore.repository.store.path=file:///srv/entrystore/data/store/)
/srv/entrystore/data/store-prov Provenance repository
/srv/entrystore/data/files Uploaded files (entrystore.data.folder)
/srv/entrystore/data/backup Backups (entrystore.backup.folder)

The image also contains the matching Solr configset in /srv/entrystore/solr/conf, see Search.

Download

EntryStore 5.x can be downloaded from entrystore.org/download/ as a Jetty bundle.

Installation in a servlet container

You can deploy the EntryStore WAR by placing it into Tomcat's webapps directory. If Tomcat is running the WAR will be uncompressed and deployed automatically. Without configuration, however, EntryStore will fail to start as it requires that a configuration file named entrystore.properties is found in the class path. It is recommended to place it at WEB-INF/classes/entrystore.properties in the folder structure of the uncompressed WAR.

Keep in mind that the folder (and the configuration file) is removed if the WAR is redeployed, so make sure that you have a copy of the configuration available.

Configuration

EntryStore is configured through a property file named entrystore.properties. A commented example file resides in the source repository:

modules/rest/spring-boot/src/main/resources/entrystore.properties_example

modules/rest/src/main/resources/entrystore.properties_example

The following parameters have to be configured individually depending on your system's configuration. The path values need attention because they must be writable by the user under which EntryStore is executed.

  • entrystore.baseurl.folder: The URL under which EntryStore is reachable for clients, e.g. https://domain.tld/store/. It must end with a slash ("/"). Behind a reverse proxy this is the public URL, not the internal one. In 6.x the setting is mandatory, and its path normally ends with the context path (/store/ by default).
  • entrystore.data.folder: The local folder where the uploaded files are going to be stored.
  • entrystore.backup.folder: The local folder where the backups are going to be stored.
  • entrystore.repository.store.path: The path to the local folder where the metadata store is going to be stored. Please observe that this is the only value which is a file-URL (file://).
  • entrystore.solr.url: The URL of the Solr core, if search is enabled. In 6.x this must be an HTTP(S) URL.

Which other parameters need to be configured depends on your use case, e.g. for a simple test instance it is possible to leave the remaining parameters untouched.

Test instances without HTTPS

In 6.x the session cookie is marked Secure by default, so browsers only send it over HTTPS. A test instance that is accessed via plain HTTP on another host than localhost needs entrystore.auth.cookie.secure=false for logins to work.

You may find explanations for the remaining parameters directly in the example configuration, on the Settings page, or in the Knowledge Base.

The admin user is created when the repository is initialized. In 6.x, its password can be set with the environment variable ENTRYSTORE_ADMIN_PASSWORD at that time; the password must meet the configured password rules. The setting entrystore.auth.adminpw temporarily overrides the admin password.

Optional: Building EntryStore from source

Source code

The source code is available from the Git repository hosted at Bitbucket.

Build

EntryStore 6.x is built with the Maven Wrapper that is part of the repository, so no Maven installation is needed. Java 25 is required.

./mvnw clean install -Dmaven.test.skip=true

The executable jar is created at modules/rest/spring-boot/target/entrystore-rest-spring-boot-<version>-exec.jar. A Docker image can be built with ./docker/build.sh.

Maven is used to build EntryStore and its sub-projects. To build EntryStore run the following commands:

mvn -Dmaven.test.skip=true install

During the build process the configuration files are copied to modules/rest/target/entrystore-{VERSION}/WEB-INF/classes/. This means that you can edit the configuration files directly there without rebuilding EntryStore. You have to restart EntryStore in the Tomcat manager or restart Tomcat to bring the new configuration into action.

You can point Tomcat directly to the built folder structure using a configuration file in /var/lib/tomcat{VERSION}/conf/Catalina/localhost/. There you simply create a file called store.xml which contains the following lines (adapt the path to your configuration):

<Context
  path="/store"
  docBase="/path/to/entrystore/modules/rest/target/entrystore-{VERSION}/"
  reloadable="false">
</Context>

Once the XML configuration is in place Tomcat automatically deploys the new context. If this for some reason does not happen you may need to restart Tomcat.

During the build, Maven downloads build dependencies from remote Maven repositories. The first build of a freshly checked out project therefore takes longer than subsequent ones.