/
Administrator Documentation: Configuration Initializer

Administrator Documentation: Configuration Initializer

Owned by Caleb Steele-Lane
Last updated: Oct 08, 2024 by Taib
2 min read

Version:
Date: 2024-09-25
Author: Caleb Steele-Lane

1. Introduction

1.1 Feature Overview

Allows the setting and changing of basic OpenELIS-Global configuration options at startup via property files.

1.2 Audience

Administrators in charge of setting up and configuring OpenELIS-Global instances

2. Getting Started

2.1 Prerequisites

Must be running a version of OpenELIS-Global > 3.0

3. Using the Feature

3.1 Step-by-Step Instructions

3.1.1 Task 1: Mounting files to use via Docker

  1. Open your projects docker-compose.yml in a text editor

  2. Identify the service oe.openelis.org

  3. Identify the volume section under the service

  4. Add an entry to the volume section

    1. - <path on server>:/var/lib/openelis-global/properties

    2. ex. - /var/lib/openelis-global/properties:/var/lib/openelis-global/properties

       

3.1.2 Task 2: Create change file

  1. Create a file in your properties docker mount point: SystemConfiguration.properties

  2. Open the file in a text editor

  3. Enter the properties you would like to change

  4. Save the changes and restart the OpenELIS-Global docker containers

  5. Confirm that the container starts up properly and that SystemConfiguration.properties is renamed to ChangedSystemConfiguration.properties and that the final properties file TotalSystemConfiguration.properties is created

3.2 Tips and Tricks

There is no default TotalSystemConfiguration.properties, but after an instance is created and configured, you can copy the resulting TotalSystemConfiguration.properties to any new instances that you are setting up and mount it into the new instance directly without a change file. A note that the property ACCESSION_NUMBER_PREFIX should likely be changed for the new instance.

Further updates can either be via the change file, or placed directly into the final properties file.

4. Troubleshooting

4.1 Common Issues

  • If an invalid value is provided to the properties file, it may stop OpenELIS-GLobal from starting up successfully. You should maintain a copy of the last usable properties file to not lose custom changes should a bad value be introduced.

Related content