This article describes how to install and configure Elvis 5 Server on a system (referred to as a 'node') on which Elvis is not yet installed.
The process can be summarized as follows:
- Preparing your setup
- Installing the Server
- Basic Server configuration
- Starting the Server
- Activating licenses
- Monitoring the status of the Server
- Setting up the Elvis environment
- Testing the Server
1. Preparing your setup
Before starting with the actual installation it is important to have a plan of how your setup will look:
- Will you run the full Elvis environment on a single machine?
- Will you spread the workload across multiple nodes in your cluster by setting up dedicated search nodes and processing nodes?
- What hardware and operating systems will you need?
The answers to these questions will affect how you are going to set up each node in the cluster. The following sections will help you find answers to these questions.
Single-node or cluster-node setup?
Elvis Server can take on the role of a search node, a processing node and/or a job runner node or any combination of these roles.
A typical production environment consists of a cluster of at least 3 nodes containing multiple search nodes, processing nodes and job runner nodes. This makes sure that redundancy is achieved: when one machine fails, the cluster itself still functions.
For demo purposes you would use a single machine (such as a laptop) with one Elvis Server instance installed that takes on all 3 roles.
In this cluster, 1 Elvis installation is used as a Search node while the load of processing files and generating previews is balanced over 2 separate Elvis installations that act as Processing nodes.
For more information, see The Elvis 5 structure: clusters and nodes.
System requirements
For detailed information about which hardware and operating systems to use, see the following articles:
Available ports
For information about available ports, see Elvis 5 Server network ports.
Network products and RFC compliancy
The Elvis Web clients are run in a Web browser and references to assets and queries are therefore expressed in URLs. These URLs can contain ////-sequences and diacritics such as accented characters.
Please note that the URLs that are generated by Elvis are compliant with the URI syntax RFC 3986. Make sure that your network environment such as proxies, gateways and firewalls also support this standard so that the URLs can be successfully routed.
(MacOS) Setting the maximum file limit
The number of files that can be opened simultaneously on MacOS systems is set very conservatively, namely to 256 files. This could potentially lead to socket exceptions or a 'Too many open files' error message. It is recommended therefore to increase this limit.
Step 1. Verify the current file limit by entering the following command in the Terminal:
launchctl limit maxfiles
It will likely state the following, indicating that the default limit of 256 files is set:
maxfiles 256 unlimited
Step 2. Increase the limit for your version of MacOS.
Note: The steps to perform can be different for each version. A good place to start for finding the steps you need is to Google on changing the maximum file limit on macos.
Step 3. Restart the system to implement the changes.
Naming the cluster and its nodes
During the basic configuration of Elvis Server you will have to define a name for the cluster and (optionally) a name for each node. Think of some descriptive names to use to easily identify the cluster and each node.
Note: For naming a node, Elvis can also be configured to automatically set a random name or use the computer name.
2. Installing Elvis Server
Installing Elvis Server is done by using an installer. Download it from the software download page.
Notes:
|
Run the installer and follow the instructions on screen.
About setting the data locations
- The Elvis Shared Data folder is used to store all the data (such as the original files and thumbnails). See also Solutions for storing files with Elvis 5.
- The Elvis Hot Data folder is used to store the search index.
- Change the server port when the default port is already in use.
Important: After installation, do not run Elvis Server before performing the basic server configuration steps.
Step 1. Run the installer and in the opening screen double-click the install icon.
Follow the steps on-screen.
This can occur on systems for which the Security & Privacy settings are set too strict. Access System Preferences > Security & Privacy and temporarily set the option 'Allow apps downloaded from' to 'Anywhere'.
Once the installation is complete, set it to the original setting again.
About setting the data locations
- The Elvis Hot Data folder is used to store the search index.
- The Elvis Shared Data folder is used to store all the data (such as the original files and thumbnails). See also Solutions for storing files with Elvis 5.
- Change the server port when the default port is already in use.
Important: After installation, do not run Elvis Server before performing the basic server configuration steps.
Step 1a. Unzip the installer by using bzip2.
Use one of the following commands (depending on your distribution):
yum install bzip2
apt-get install bzip2
Step 1b. Extract the Elvis installer. Make sure to replace "x.x.x.x" by the version number, as shown in the file name.
#bzip2 -d elvis-x.x.x.x-server-linux.bin.bz2
Step 1c. Run the installer by running the following command (as root). Make sure to replace "x.x.x.x" by the version number, as shown in the file name.
# sudo sh ./elvis-x.x.x.x-server-linux.bin -i
Step 1d. Follow the instructions on screen.
Note: We strongly advice to use the default settings.
Important: After installation, do not run Elvis Server before performing the basic server configuration steps.
Disable scheduled cleanup of var/tmp
Some Linux versions may clean the var/tmp folder which may result in server failures. To prevent this, use one of the following methods:
Step 1. open the following file:
/etc/cron.daily/tmpwatch
Step 2. Search for the following line:
/usr/sbin/tmpwatch "$flags" 30d /var/tmp
If this line is present it means the /var/tmp folder will be cleaned every 30 days.
Step 3. Disable this line by adding # in front of the line or add the following line where x.x.x.x is the ip of the server and port is the port. The exact name can be found in the /var/tmp folder after the server was started for the first time:
-x /var/tmp/jetty-x.x.x.x-port-webapp.war-_-any-
-x /var/tmp/elvis_app
Use the following commands:
systemctl disable systemd-tmpfiles-clean.timer
systemctl mask systemd-tmpfiles-clean.timer
3. Basic Server configuration
Note: This section describes the basic server configuration steps that are required to get Elvis Server up and running. Additional configuration steps are described later.
How to configure your cluster and each node within the cluster depends on the choices you made in Preparing your setup. At this stage you should know:
- How to name your cluster and each node within the cluster
- How many nodes you will have in your cluster
- Which nodes will take on the role of a Search node, a Processing node, a Job Runner node, or a combination of these roles
- If your file store is on the same node on which Elvis Server is installed or placed at a shared location
Basic configuration can be broken down into the following tasks:
- Configuring the settings specific for the cluster
- Configuring the settings specific for an individual node
- Repeating the process on each node
1. Configuring the cluster settings
Note: The cluster-config.properties.txt file needs to be identical for all node configurations. After setting up the first node and configuring subsequent nodes, make sure that any changes to a cluster property are implemented in the cluster-config.properties file for all nodes. See also Changing the Elvis 5 Server configuration for a running cluster.
Step 1. Access the Elvis Server/Config folder on one of the nodes.
Step 2. Open the cluster-config.properties.txt file and set the following options:
- cluster.nodeCount. Set this to the total number of nodes in your cluster.
Example: Here a setup of 5 nodes is used. Therefore "5" is entered: cluster.NodeCount=5 |
- cluster.searchNodeCount. Set this to the number of nodes in your cluster that act as a Search node.
Example: Here, 3 nodes will take on the role of Search node. Therefore "3" is entered: cluster.searchNodeCount=3 |
Step 3. Save and close the file.
2. Configuring the node settings
Step 1. In the same folder as where you opened the cluster configuration file (Elvis Server/Config), open the node-config.properties.txt file and set the following options (listed in the order in which they appear in the file):
- clusterName. Set this to a unique name for your cluster.
Example: clusterName=ElvisDemo
Note: This name needs to be the same on all the nodes.
- nodeName. (Optional) By default, Elvis generates a random name for the node. To use a more descriptive name, do one of the following:
- Use the computer name by replacing the value with ${computerName}.
- Enter a custom name.
Examples: Here, a random name is generated: nodeName=${randomHeroName} Here the computer name is automatically used: nodeName=${computerName} Here a custom name is entered: nodeName=ProcessingNode1 |
- Define how Elvis Server should run: as a Search node, a Processing node, a Job Runner node or any combination of these roles. Do this by setting the following options to true or false:
searchDataEnabled=true
processingEnabled=true
jobRunnerEnabled=true
- When the sharedDataLocation is different on each node, make sure that the elasticsearch.backup.location (which references this location by default) is also configured correctly for the cluster. This can be done in the the cluster-config.properties.txt file (see Changing the Elvis 5 Server configuration for a running cluster).
- fileStoreType. When the file store is configured on the same node on which Elvis Server is installed, set this option to "local".
Note: This is typical when installing Elvis Server on a laptop for demo purposes.
Example: fileStoreType=local
Step 2. Save and close the file.
3. Repeating the process
Now that the first node in the cluster has been installed and the basic configuration settings for it have been set, repeat all these steps on each of the other nodes.
To save you some time, run the installer on each node and replace the config folder by a copy of the config folder of the node that is already configured. This way, the cluster settings are already correctly set and you only have to modify the node settings where needed.
To summarize those settings:
File: node-config.properties.txt
Settings:
- The clusterName should be the same for all nodes and therefore does not have to be changed here.
Example: clusterName=ElvisDemo
- Set nodeName to the computer name, a custom name, or keep the default setting to have a random name generated.
Examples: Here, a random name is generated: nodeName=${randomHeroName} Here the computer name is automatically used: nodeName=${computerName} Here a custom name is entered: nodeName=ProcessingNode1 |
- Define if Elvis Server should run as a Search node, a Processing node, a Job Runner node or a combination of these roles:
searchDataEnabled=true
processingEnabled=true
jobRunnerEnabled=true
- Set fileStoreType to local when the file store is configured on the same node on which Elvis Server is installed.
Example: fileStoreType=local
Save and close the file.
4. Starting Elvis Server
Once Elvis Server is fully installed and configured, start Elvis Server on each node on which it is installed.
- From the Elvis Server panel, click Start.
Applications > Elvis Server
Do one of the following:
- From the Windows Start menu, choose Elvis Server > Start.
- Access Administrative Tools > Services and start the "Elvis Server" service.
Enter sudo service elvis-server start
The startup process takes a few moments (longer than what you may be used to with Elvis 4 Server) because of various processes that have to start up and have to negotiate and communicate with each other.
Monitor the progress by viewing the log file for that session:
- Mac OS X: double-click /Library/Logs/ElvisServer/<date-timestamp>.stderrout.log to open it in the Console
- Mac OS X: Open the Console and in the Log List, choose the most recent <date-timestamp>.stderrout.log file from ElvisServer
- Windows: open C:\ProgramData\Elvis Server\Logs\<date-timestamp>.stderrout.log (use mTail to open the file)
- Linux: enter tail -f -n 300 /var/log/elvis-server/<datetimestamp>.stderrout.log
Wait until the process is completed and all nodes are ready. The Server will eventually run in "fallback mode" until it is licensed.
5. Licensing Elvis server
Before the Server and the client applications that connect to it can be used, licenses need to be activated.
Note: When a server is not licensed it will start up in "fallback mode". In this mode, only the admin page and activation page are available.
Step 1. Open the following page in your browser:
http://<yourserver>:<port number>/admin
Example: localhost:8080/admin.
Note: You can log in using the default admin user with password changemenow, but make sure to change the password in the internal user properties.
The page will open in Fallback mode (see below) and will display a warning.
Step 2. Open the License page by clicking License in the top left corner.
Step 3. Enter your serial number, name and e-mail address and click OK.
An overview appears of the products that you can activate.
Step 4. Select a Server product.
Step 5. Specify the number of licenses to activate for each product.
Note: By default, all available licenses are entered.
Step 6. Click Activate.
If all goes well your activation code is successfully activated.
Step 7. Click OK.
The Activation page reloads and all options in the menu on the left are now available.
Step 8. Restart all nodes in the cluster.
- From the Elvis Server panel, click Restart.
Applications > Elvis Server
Do one of the following:
- From the Windows Start menu, choose Elvis Server > Service Start.
- Access Administrative Tools > Services and restart the "Elvis Server" service.
Enter sudo service elvis-server restart
6. Monitoring the state of Elvis Server
With the installation process completed, check that Elvis Server is running correctly by using the options on the Server Status page.
Cluster health is indicated as follows:
- Green: The cluster is running without any problems.
- Yellow: The cluster can be used but it is not in a redundant state.
- Red: The cluster is not functional.
Step 1. On one of the machines, access the Elvis Server Admin page.
Enter the following URL:
http://<yourserver>:<port>/admin
Step 2. Click Server status in the menu bar.
7. Setting up the Elvis environment
Now that Elvis Server is installed it can be further set up for full use. This includes the following:
- Additional configuration
- Assigning memory
- Installing the Desktop Client
- Setting up the Brand portal and / or Pro client
- Adding Elvis to InDesign
- Setting up users and user groups
- Setting up user permissions
- Setting up taxonomy
- Setting up custom metadata
- Implementing security-related features
- Adding watermarks to images
- Adding features through plug-ins
- (Optional) Installing demo files
- (Optional) Adding assets in Elvis in bulk
- Using Amazon CloudFront to speed up connections from remote locations
8. Testing Elvis Server
Verify that Elvis Server is working properly by using the Desktop client or the Pro Client. Perform tasks such as uploading some files, searching for them, downloading or sharing them, or any other tasks that are part of your daily workflow.
Document history
- 3 October 2018: Updated section 1 'Preparing your setup' by adding information about network products and RFC compliancy.
- 31 August 2018: Updated section 4 'Starting Elvis Server' by correcting the path to the .stderrout.log file.
- 15 August 2018: Updated section 2 'Configuring the node settings' by removing step 3 'Opening the necessary firewall port'.
Comment
Do you have corrections or additional information about this article? Leave a comment! Do you have a question about what is described in this article? Please contact Support.
0 comments
Please sign in to leave a comment.