A Docker image running on eXist-db with a predeployed Edirom Online, and options for deploying additional XAR archives on-build or on-run.

This Docker image is a multi-stage Docker image and has the following stages:

• STAGE 1: xar-fetcher

  The xar-fetcher stage is based on bwbohl/sencha-cmd:2.1.0 and uses multiple strategies to retrieve the EXPath Packages (XAR archives) to be deployed to STAGE 2. One option is to inject local XAR archives (cf. Building the Docker Image).

• STAGE 2: edirom-online

  The edirom-online stage is based on stadlerpeter/existdb:6.4.0, which runs an eXist database. STAGE 2 copies XAR archives fetched by STAGE 1 and places them into the autodeploy directory of the eXist database. Moreover, it provides a method for deploying additional XAR archives to the eXist database when running the Docker image for the first time (cf. Running the Docker Image).

If you want to pull the latest version of a pre-built Docker image run:

docker pull ghcr.io/bwbohl/docker-edirom-online:latest

For available tags please visit: https://github.com/baz-ga/docker-edirom-online/pkgs/container/docker-edirom-online

docker run -p 8080:8080 -v `pwd`/add-xars:/var/add-xars ghcr.io/bwbohl/docker-edirom-online

If you want to run the Docker image and start using eXist-db with an installed Edirom Online, e.g., run:

docker run -p 8080:8080 ghcr.io/bwbohl/docker-edirom-online

Suppose you want to deploy additional XAR archives to the eXist database when running the Docker image for the first time. In that case, you can use the Docker -v flag to mount a local directory to the Docker image’s /var/add-xars directory, e.g. by running:

docker run -p 8080:8080 -v `pwd`/add-xars:/var/add-xars ghcr.io/bwbohl/docker-edirom-online

The final image (i.e., STAGE 2) will copy any XAR archive in your local directory to the autodeploy directory of the eXist database and thus deploy it on first run.

As the final stage of the Docker image is based on stadlerpeter/existdb:6.4.0, all environment variables defined for it are valid run arguments for the Docker image.

For an overview, please visit the corresponding documentation

This Docker image overrides the following environment variables if not set to other values in the docker run command:

• EXIST_DEFAULT_APP_PATH

  Set to xmldb:exist:///db/apps/Edirom-Online to make Edirom Online the default app.

• EXIST_CONTEXT_PATH

  Set to / to make Edirom Online available at the root of the configured host and port.

• EXIST_ENV

  Set to development.

[!WARNING] Building this Docker image requires a GitHub API Token for fetching the Edirom XAR archives. There are several ways to provide your GitHub API Token securely (cf. Docker build secrets documentation).

For illustrative purposes, let’s consider you save it in a simple text file, e.g., called MY_GITHUB_API_TOKEN, in the form:

GITHUB_API_TOKEN=ghp_************************

When issuing the build, you should provide this file using the --secretoption, as in the following example:

docker build -t ghcr.io/bwbohl/docker-edirom-online:mytag --secret type=file,id=GITHUB_API_TOKEN,src=/PATH/TO/MY/SECRET/MY_GITHUB_API_TOKEN .

The xar-fetcher stage uses the xar-fetcher-entrypoint.sh to determine how to obtain the Edirom Online XAR archives, this depends on several build arguments:

• EDIROM_VERSION_STRATEGY

  The version strategy for fetching the Edirom Online XAR archives. (default: 1.0.0).

  The build differentiates between values greater than or equal to 2.0.0 and values less than 2.0.0 and applies different strategies:

  • < 2.0.0: download a monolithic Edirom Online including both the frontend and the backend. The assumed repository name is Edirom-Online.

  • >= 2.0.0: download separate Edirom Online Frontend and Edirom Online Backend. The assumed repository names are Edirom-Online-Frontend and Edirom-Online-Backend.

• EDIROM_OWNER

  The owner (organisation or user) of the Edirom-Online or Edirom-Online-Frontend and Edirom-Online-Backend repositories on GitHub (default: Edirom).

• EDIROM_REF

  The git reference (branch or tag) to use for fetching the Edirom Online XAR archives (default: v${EDIROM_VERSION_STRATEGY}).

  If the reference is a tag, the build assumes a tagged release and downloads any XAR archive (.xar) from the release assets.

  If the reference is a branch, the build will check out the branch and try to run build.sh in the branch’s root to create an XAR archive.

• EDIROM_COMMIT

  The git SHA of the Edirom Online version (default: unknown). Will be used in the metadata of the final Docker image. When you build the image using build.sh from this repository, the git SHA of the installed Edirom XAR will be automatically determined.

• BUILD_DATE

  The date when the Docker image was built (default: 1970-01-01T00:00:00Z).

As the final stage of the Docker image is based on stadlerpeter/existdb:6.4.0, all build arguments defined for it are valid additional build arguments for the Docker image. For an overview, please visit the corresponding documentation.

This software is published under the terms of the GNU General Public License 3 (GPL-3.0-only).

Code required for execution of this software is published under the terms of the GNU General Public License 3 (GPL-3.0-only) licence, corresponding documentation is published under the terms of the Creative Commons Attribution-ShareAlike 4.0 International licence (CC-BY-SA 4.0). For a detailed clarification, please consult the individual licence and SPDX-License-Identifier statements in the preamble of each file.

• Base image: bwbohl/sencha-cmd - GPLv3
• baz-ga/gh-asset-downloader - GPLv3

• Base image: stadlerpeter/existdb - MIT License
  • Based on: eclipse-temurin:17-jre - Apache License 2.0
  • Includes: OpenJDK - GPLv2 with Classpath Exception
    • See DockerHub for additional licence information
• eXist-db - LGPL-2.1
• Edirom Online - GPLv3

The referenced Docker images may contain additional software under various licences.

It is the responsibility of the user of any pre-built image to ensure that any use complies with all relevant licences for all software contained within.

This Docker image was developed in the context of the Bernd Alois Zimmermann-Gesamtausgabe project (BAZ-GA).

The Bernd Alois Zimmermann-Gesamtausgabe. Historisch-kritische Ausgabe seiner Werke, Schriften und Briefe (Bernd Alois Zimmermann Complete Edition. Historical-Critical Edition of his Works, Writings, and Letters) are promoted by the Union of the German Academies of Sciences and Humanities, represented by the Academy of Sciences and Humanities Berlin-Brandenburg and the Academy of Sciences and Literature | Mainz, funded by the Federal Ministry of Education and Research, Bonn and Berlin, the Berlin Senate Department for Higher Education and Research, Health and Long-Term Care and the Hessian Ministry of Science and the Arts, Wiesbaden.

For more information, please visit: https://www.zimmermann-gesamtausgabe.de.