For Linux

Preparations

Before installing Elixir Ambience on Linux, be sure to set up the ZooKeeper properties using either approach:

ZooKeeper Properties Approach

The ZooKeeper Properties Approach is more secure as it ties the ability to run services to a particular user account.

Create three /.elixirtech directories and set permission owners as shown in the table below.

Table 2.1. /.elixirtech directories and permission owners

DirectoryPermission Owner
/root/.elixirtechroot
/home/elixir/.elixirtechelixir
/home/<user>/.elixirtech<user>

In the /root/.elixirtech directory, create the zookeeper.properties file by copying the following contents into it. Fill in your host machine name and domain names. Leave the default ZooKeeper port as 2181 unless there is a clash with another service. The timeout indicates the heartbeat in milliseconds of the ZooKeeper cluster. If you need to configure a cluster, add more hosts here:

hosts=<machine-name>:2181
timeout=5000
domain.eno=<key>

Copy the zookeeper.properties file into the other directories as shown in the table. The three copies of zookeeper.properties should contain exactly the same contents. Once the contents change, you should modify the three copies.

Note

If you need to add more domains, follow the syntax below. <name> should only include letters and numbers, while <key> can include any characters. Domain name and key must be set before the domain is created, otherwise the domain is not accessible. Once set, the key cannot be changed. If a new key is needed, you need to export the contents of the domain using the old key, configure a new domain with a new key and import the contents with the new key in place.
domain.<name>=<key>

System Preferences Approach

The System Preferences Approach is simpler as it sets the values for all users. Using this approach, you need to maintain only one copy of file. Although this approach makes editing easier, it is not as secure as the ZooKeeper Properties Approach.

Open the install.sh file with Text Editor. Uncomment the following contents to use system preferences instead of zookeeper.properties. Please note that you need to run as an administrator with "sudo" commands to alter the values:

#sudo ./elx-zookeeper-init.sh --hosts "$<host-name>:2181" --timeout
 5000
#sudo ./elx-zookeeper-init.sh --add $<domain> <domain-name>
#./elx-zookeeper-init.sh --display

If there is a zookeeper.properties file present for a particular user account, it will be used instead of any system preferences.

Install Elixir Ambience on Linux

To install Ambience on Linux, complete the following steps:

  1. Open the Terminal window. Change to the directory that contains the install.sh file.

  2. Type the following command lines to change the mode of the install.sh file to be executable:

    chmod +x install.sh

  3. Type the following command lines to run the install.sh file. The installation process start:

    ./install.sh

  4. Look out for any error messages which might occur if existing services use the default ports that Elixir Ambience needs. Install will create a new "elixir" user which will be used to run all services. Services will automatically start each time the computer is switched on.

  5. Obtain and add any necessary JDBC drivers to the /var/elixir/lib folder.

  6. If you have added new jars to the lib folder, run ./stop.sh and then ./start.sh for them to be included in the restarted environment.

Elixir Ambience is successfully installed.

Note

If you receive an error message during installation, saying “Unable to connect to ZooKeeper domain eno”, you might have to manually update IP address in the /etc/hosts file.

Uninstall Elixir Ambience from Linux

To uninstall Ambience from Linux, complete the following steps:

  1. Open the Terminal window. Change to the directory that contains the uninstall.sh file.

  2. Type the following command line to change the mode of the uninstall.sh file to be executable:

    chmod +x uninstall.sh

  3. Type the following command line to run the uninstall.sh file:

    ./uninstall.sh

Elixir Ambience is successfully uninstalled.

On Linux operating system, you can also run the following files:

Table 2.2. Executable files on Linux

FileDescription
reinstall.shThis file uninstalls and then reinstalls the program. User configurations and repository contents are preserved. This script is useful to upgrade your installation when new versions are available.
start.shThis file starts all the services.
stop.shThis file stops all the services.
wipe.sh This file wipes all zookeeper and repository contents. All user configuration will be deleted. You should only use this script after running uninstall.