During the installation of Elvis 5 Server, basic configuration settings were made. Once the cluster is up and running, additional properties can be configured to further unlock functionality and features. As was the case during the installation, configuration can be done for each specific node and for the cluster itself.
This article describes how to do both.
To restart or not to restart Elvis Server?
A common question that is asked is whether or not Elvis Server should be restarted after making changes to the configuration files.
The answer to this question can be found in the comments for each setting in the configuration files. Look for the following statements:
"requiresRestart" : false
"requiresRestart" : true
Changing the properties for a specific node
Step 1. Open the following file on one of the nodes in the cluster:
Step 2. Change any of the properties as explained in the comments of the file.
Step 3. Save and close the file.
Step 4. Restart Elvis Server when needed.
Changing the properties for the cluster
During the installation of Elvis 5 Server the cluster properties were configured by manually modifying the cluster-config.properties.txt file.
Once the cluster is up and running though, changing the cluster properties should be done through the Elvis Config Properties page on one of the nodes. After saving the changes, Elvis will automatically distribute the changes across all other nodes.
Important: Modifying the cluster-config.properties.txt file on a node in a running cluster by manually opening it from the Elvis Server/Config folder should not be done; this can result in nodes with different cluster properties which can lead to unpredictable behavior.
Step 1. Access the admin pages by doing one of the following:
- Enter the following URL:
- On the Elvis Server console, click Server admin page
Step 2. Click Change config in the menu bar.
Looking up the available properties
An overview of the available properties, their description and whether or not changing them requires a cluster restart can be found by clicking List config properties at the top of the page under 'Config properties'.
Checking the currently set properties
To see the properties that are currently set for the cluster, click any of the links in the 'Choose a file' section. This will open that particular file for editing.
Figure: The content of the cluster-config.properties.txt file, showing the properties set for that file for the whole cluster.
Editing a property
Editing a property can be done in 2 ways:
Step 1. In the Choose config file section, click any of the links to open the file.
The page for changing the file properties appears.
Step 2. Add or change a property with its value and click Save changes.
Tip: For files with a lot of content it might be handy to copy the content to your favorite text editor such as TextWrangler or Notepad++ so that you can easily read and edit the configuration settings. When finished editing, paste the content back into the Elvis page.
Step 3. Restart Elvis Server when needed.
Step 1. In the Config properties section, click Set config properties.
A page showing all properties that can be set appears.
Step 3. In the address bar of your web browser, add the properties you want to change by using the following syntax:
Example: Here the 'locale' property is set to 'de_DE':
Step 4. Press Enter to run the command.
The page is updated.
Step 5. Verify on the page that the value of the property has changed.
Step 6. Restart Elvis Server when needed.