softproject/x4_bipro_server repository overview

⁠Custom X4 BiPRO Server Docker Image

This Docker image provides a customizable X4 BiPRO Server environment based on X4. It includes comprehensive configuration options to tailor the server to your specific needs.

⁠Key Features

• Custom Configurations: Easily add configurations like keycloak_config.json, BAM Log, or SQL Profiling configurations to /opt/X4/configurations.
• X4 Projects and X4DB: If X4Apps cannot be used, add your X4 Projects during the build process.
• Deployments: Store X4Apps and .runtime configurations of X4Apps and X4 Projects in /opt/X4/deployments. Add them during the build process.
• Wildfly Configuration: Modify Wildfly settings by editing standalone.xml or configuring Wildfly from an external volume.
• Licenses: Ensure x4.license and x4bipro.license are present in /opt/X4 for proper functionality.
• Adapter Support: Add new Adapters that are not included in the standard X4 image.
• Troubleshooting Tips: Guidance on handling volumes and deployments to avoid overwriting existing content.

⁠Usage

To configure your custom X4 BiPRO Server image, follow these steps:

⁠Configurations

Add your custom configuration files to /opt/X4/configurations. The file names given here are just examples, please read the documentation for the exact naming needed.

COPY keycloak_config.json /opt/X4/configurations/keycloak_config.json
COPY bam_log_config.xml /opt/X4/configurations/bam_log_config.xml
COPY sql_profiling_config.xml /opt/X4/configurations/sql_profiling_config.xml

⁠X4DB and X4 Projects

Include your X4 Projects during the build if X4Apps are not or cannot be used. Do not overwrite or remove the existing X4BiPRO X4 project in /opt/X4/X4DB/1 as it is an integral part of X4 BiPRO Server and will break your BiPRO system.

It is recommended to gather your X4 Projects from your Version Control System in the docker build context in order to simply ADD the whole directory into your image like this:

ADD MySpecialProject /opt/X4/X4DB/1/MySpecialProject

⁠Deployments

Store your X4Apps and .runtime configurations in /opt/X4/deployments during the build process.

X4Apps are most often a kind of container to package multiple inter-dependent X4 Projects. The .runtime configuration is valid per single project, so they will be stored in the /opt/X4/deployments/YourX4App directory and will have the name YourX4Project.runtime, matching the name of the X4 Project.

COPY YourX4App.x4app /opt/X4/deployments/YourX4App.x4app
COPY YourX4App.runtime /opt/X4/deployments/YourX4App/YourX4Project.runtime

⁠Wildfly

Configure Wildfly by modifying standalone.xml or through an external volume.

COPY standalone.xml /opt/X4/wildfly/standalone/configuration/standalone.xml

Alternatively, you can link the folder as a volume and configure Wildfly from outside the container:

VOLUME /opt/X4/wildfly/standalone/configuration

⁠Licenses

Place x4.license and x4bipro.license in /opt/X4/licenses. This is the default location configured in the X4 BiPRO Server image.

COPY x4.license /opt/X4/licenses/x4.license
COPY x4bipro.license /opt/X4/licenses/x4bipro.license

⁠Additional Adapters

All the following configurations will be under the base path of /opt/X4/wildfly/modules/system/layers/base. To shorten the description, $BASE will be used as a substitute for this base path.

Include any new adapters not provided in the standard X4 installation. In order to deploy them, extract the Wildfly Module you were provided and add it at $BASE, meaning to continue the path with the directories created from the .zip like this: de/softproject/x4/adapter/../main

If you have multiple adapters to deploy, it might be easier to first unzip all of them to the docker build context (e.g. local directory) into a de/softproject/x4/adapter/... directory and then add the whole de directory to $BASE in the image.

ADD de /opt/X4/wildfly/modules/system/layers/base/de

Afterwards, add all the Adapter modules you just added must also be added to the SoftProject extensions module under $BASE/de/softproject/x4/extensions/main/module.xml with an entry for each Adapter in the <dependencies> element like this:

<dependencies>
    <module name="de.softproject.x4.adapter1" export="true"/>
    ...
    <module name="de.softproject.x4.adapterN" export="true"/>
</dependencies>

This can be achieved with e.g. some sed magic, for usage, see the sed manuel⁠.

⁠Troubleshooting

When adding a volume to X4DB, ensure it does not overwrite existing content. It is recommended to deploy all X4 projects and workspaces at build time and store data in a different location/volume.

For detailed guidance on building and configuring your custom BiPRO image, refer to the documentation included in the repository.