evolvedbinary/elemental repository overview

Elemental is a high-performance Open Source Native XML and JSON Database; a NoSQL document database and application platform built entirely around XML and JSON technologies. The main homepage for Elemental can be found at elemental.xyz⁠. This is just the Docker Image repository for Elemental releases.

⁠Help and Support

The best place to seek help or support is in our public Slack⁠ channel, or on our Mailing List⁠.

⁠Docker Images Provided

All images are built on Chainguard's Wolfi base⁠ image to provide a secure experience.

For each release of Elemental, we provide two types of Docker Image. For example, for the Elemental 7.7.0 release you will find these two tags are available:

1. 7.7.0 - this is the image designed for your use in a production environment.

   • It is secure by default.
   • It has only a JRE
   • It does not have a shell.
   • The startup command is not overridable.
   • Elemental runs under the system user and group edb01.

2. 7.7.0-DEBUG - this image is designed so that users may execute the Elemental CLI tools, or so that developers may debug any issues,

   • It has a full JDK.
   • It has a shell.
   • The startup command is overridable.
   • Elemental runs under the system user and group edb01.
   • Elemental is started by default with Java Debugging (JDWP) enabled on port 5005.
   • A full interactive user debug with sudo access is provided.

In addition to the tags for each release are two generic helper tags:

1. latest - this always points at the most recent production image release.
2. debug - this always points at the most recent debug image release.

⁠Docker Image Contents

Within each Docker Image, Elemental is installed into /elemental and the ELEMENTAL_HOME environment variable is set to the same.

You may with to bind one or more of Elemental's data and config folders to the host system, or make use of Docker Volumes depending on your needs:

• /elemental/autodeploy - EXPath Packages (XAR) that should be auto deployed into the database EXPath Repository.
• /elemental/etc - Elemental configuration files.
• /elemental/logs - Elemental log files.
• /elemental/data - Elemental database files.

⁠Image Build Arguments

If you wish to build your own Elemental Docker Images, or derive your own images based on the Elemental images, the following Docker Image build time arguments are available to be configured:

⁠Arguments for Elemental Server

• ELEMENTAL_SERVER_SERVICE_ACCOUNT (default: edb01) This is the Linux system user account name to run Elemental Server under.

• ELEMENTAL_SERVER_SERVICE_GROUP (default: edb01) This is the Linux system group name to run Elemental Server under.

• ELEMENTAL_SERVER_CACHE_MEM (default: 256) The amount of memory to allocate for Elemental Server's cache (in MB).

• ELEMENTAL_SERVER_MAX_BROKER (default: 20) The number of concurrent incoming connections that Elemental Server should serve before queuing subsequent incoming connections.

• ELEMENTAL_CONTAINER_DEBUG_USER_ACCOUNT (default: debug) The name of the full Linux user account and group to use for the debug user. Only available in DEBUG images.

⁠Arguments for the JVM

• JVM_MAX_RAM_PERCENTAGE (default: 75.0) Maximum JVM RAM use as a percentage of RAM available to the Docker Container.
• JVM_GC (default: Z) The name of the Java Garbage Collector to use.
• ADDITIONAL_JAVA_TOOL_OPTIONS Any additional options to be added to the JAVA_TOOL_OPTIONS Environment Variable for the JVM
• JVM_JDWP_SUSPEND (default: n) Whether the Java debugger should suspend the startup of the JVM until a Java debugger connects. Only available in DEBUG images.
• JVM_JDWP_ADDRESS (default: 5005) The port that the Java debugger server (JDWP) should listen on for Java debugger connections. Only available in DEBUG images.

⁠Resources

• Homepage: https://www.elemental.xyz⁠
• Binaries: https://www.elemental.xyz/downloads⁠
• Homebrew: https://formulae.brew.sh/cask/elemental⁠
• Docker Images: https://hub.docker.com/r/evolvedbinary/elemental⁠
• Documentation: https://www.elemental.xyz/documentation⁠
• Book: https://www.oreilly.com/library/view/exist/9781449337094/⁠
• GitHub: https://github.com/evolvedbinary/elemental⁠
• Mailing list: https://groups.google.com/u/1/a/elemental.xyz/g/users⁠
• LinkedIn: https://www.linkedin.com/groups/10070373/⁠
• Slack: https://elemental-xyz.slack.com⁠