Install the ece Script

The ece shell script provides a set of commands for easily stopping, starting and assembling the Content Engine.

To install the ece shell script:

On your assembly-host, while logged in as escenic:

Make /opt/escenic/engine/ece-scripts/usr/bin/ece executable:
```
$ chmod +x /opt/escenic/engine/ece-scripts/usr/bin/ece
```
Open /home/escenic/.bashrc for editing, and add the following line to it in order to add /opt/escenic/engine/ece-scripts/usr/bin to your PATH:
```
export PATH=/opt/escenic/engine/ece-scripts/usr/bin:$PATH
```
Then enter the following command to apply the change you have made in your current shell:
```
$ source ~/.bashrc
```
Copy the script's configuration file to /etc/escenic/engine:
```
$ cp /opt/escenic/engine/ece-scripts/etc/escenic/ece.conf /etc/escenic/
```
This is the configuration file that will be read when ece is executed on the assembly-host.
If you are installing everything on one host, then skip this step.

Copy the script's configuration file to each of the host configuration folders you have made. For example:
```
$ cp /opt/escenic/engine/ece-scripts/etc/escenic/ece.conf /etc/escenic/ece-editorial1.conf
            $ cp /opt/escenic/engine/ece-scripts/etc/escenic/ece.conf /etc/escenic/ece-presentation1.conf
```
These are the configuration files that will be read when ece is executed on the various engine-hosts. (If your assembly-host is also an engine-host, then you do not need a copy in /etc/escenic/engine, the host-specific copy will be used.)
Open the copies of ece.conf that you created in steps 4 (and possibly 5), and make sure that the parameters listed below are set correctly for your installation, and for the specific host they correspond to. If you have followed all the instructions in this guide exactly, then the following settings should work:

java_home

Make sure that this is set to the path of the Java virtual machine included in the JDK you installed (see Install Java SE Development Kit (JDK)).

ece_home

Set this to /opt/escenic/engine.

escenic.server

Set this to the host name or IP address, should be unique for each server in a multi-server setup (not relevant for single-host installations).

ece_security_configuration_dir

Set this to /etc/escenic/engine/common/security.

appserver

Currently, the only valid setting for this is tomcat.

tomcat_home

Set this to /opt/tomcat.

solr_home

Set this to /var/lib/escenic/solr. This is the location to which you have copied the Solr configuration data (see Copy Solr Configuration).

assemblytool_home

Set this to /opt/escenic/assemblytool.
Create the standard installation directory structure. Enter the following commands:
```
            # mkdir -p /var/{crash,lib,log,run,cache,spool}/escenic
            # chown escenic:escenic /var/{crash,lib,log,run,cache,spool}/escenic -R
          
```
These commands will create the following folders and assign them to the escenic user:
```
/var/crash/escenic
            /var/lib/escenic
            /var/log/escenic
            /var/run/escenic
            /var/cache/escenic
            /var/spool/escenic
```
If, for any reason, you do not want to install Content Engine files in standard locations and you have modified any of the following settings in the ece.conf file, then you have to make sure that all of those exist and the escenic user has write permission. You are strongly advised, however, not to do so. All instructions in this manual and the Escenic Content Engine Server Administration Guide assume files are installed in standard locations. The configurations are:
```
cache_dir
```
```
log_dir
```
```
pid_dir
```
```
heap_dump_dir
```

Then, on each of your engine-hosts, while logged in as root:

Copy the ece script from the assembly-host. If you have installed an SSH server on the assembly-host and SSH clients on your engine-hosts, then you can do this as follows:
```
# scp escenic@assembly-host-ip-address:/opt/escenic/engine/ece-scripts/usr/bin/ece /usr/bin/
```
where assembly-host-ip-address is the host name or IP address of your assembly-host.
Make /usr/bin/ece executable:
```
# chmod +x /usr/bin/ece
```
Now you need to make sure that the required directory structure exists. Execute the same commands to you have used to create the directories in assembly-host with appropriate permission.
Verify that the script is correctly installed by entering the following while logged in as escenic:
```
$ ece help
```
This should give help output describing the usage of the ece command.