Difference between revisions of "Hemera:Install"

From HemeraBook
Jump to: navigation, search
(Update Operating System)
Line 54: Line 54:
 
=Setup=
 
=Setup=
 
==Update Operating System==
 
==Update Operating System==
To setup Hemera, you must launch the following script with an user having enough privileges, or using sudo (or root user):
+
You should setup Hemera for better accessibility, it will:
 +
* create a 'system' file in your home directory to define some global Hemera variables (e.g. installation directory)
 +
* update/create your ''$HOME/.bashrc'' file to add Hemera main script directories to ''$PATH'' environment variable
 +
* (since 0.2) deploy Hemera Web module (if it is activated)
 +
* (since 0.2) install Hemera service (if corresponding option is used by a privileged user)
 +
<br />
 +
 
 +
To setup Hemera:
 
  '''[[Appendix#HEMERA_ROOT_PATH |HEMERA_ROOT_PATH]]/Hemera/scripts/setupHemera.sh'''
 
  '''[[Appendix#HEMERA_ROOT_PATH |HEMERA_ROOT_PATH]]/Hemera/scripts/setupHemera.sh'''
or
 
sudo '''[[Appendix#HEMERA_ROOT_PATH |HEMERA_ROOT_PATH]]/Hemera/scripts/setupHemera.sh'''
 
  
 
<br />
 
<br />
Setup will:
+
At any time, you can launch setup (e.g. after an upgrade, or if you have changed installation directory) with the -f option to force update/rewrite of files:
* create a ''sysconfig'' file defining the installation directory
+
'''[[Appendix#HEMERA_ROOT_PATH |HEMERA_ROOT_PATH]]/Hemera/scripts/setupHemera.sh''' -f
* create a ''profile'' file adding Hemera main script directories to '''PATH''' environment variable
+
  
 
<br />
 
<br />

Revision as of 14:15, 29 May 2011

Foreword

If ever you have problem while installing Hemera or third-party tools, check the Troubleshooting page.
If you don't find solution, post a request on the Help Forum.

This page gives information to install Hemera from scratch, if you already have an Hemera version, you should consider upgrading it.


Information

Multi user

To use Hemera, there is no need special permissions.
Any user can install his own Hemera version (e.g. in his home directory), and any needed third-party tools which are not already installed on the Operating System.
Each user has a specific configuration file, allowing to adapt the behavior to his need.

Nevertheless, since v0.2, an administrator can setup Hemera service for it to start/stop in same time of the Operating System.

UTF-8

For greater interoperability and internationalization, it is recommended that you configure your OS to use UTF-8.
It can be done defining the $LANG environment variable in the good global file which depends on your operating system.
Under RedHat-like GNU/Linux distribution:

/etc/sysconfig/i18n

Under Debian-like GNU/Linux distribution:

/etc/default/locale


Create the file if needed, and add the following line (you can change en_US with the language of your choice, but it is mandatory to use UTF-8):

LANG="en_US.UTF-8"


Prepare a Workspace

You should begin preparing a workspace with enough space.
Let's call it HEMERA_ROOT_PATH.

Hemera is compounded of several projects:

  • Hemera: the main project
  • HemeraThirdParty: (since v0.2) third-party structure project (where you will install third-party tools)
  • HemeraTests: containing various tests scripts
  • HemeraWebModule: (since v0.2) the Web Service Module project
  • HemeraSamples: some samples (not included in binary version)
  • various tools project


Get Hemera

Hemera user

You can download Hemera binaries from the SourceForge project site:

  • enter the directory of the version you want
  • download the Hemera-vX.Y.tgz tarball (X.Y corresponding to the version)
  • uncompress it in HEMERA_ROOT_PATH


Hemera developer/contributor


Setup

Update Operating System

You should setup Hemera for better accessibility, it will:

  • create a 'system' file in your home directory to define some global Hemera variables (e.g. installation directory)
  • update/create your $HOME/.bashrc file to add Hemera main script directories to $PATH environment variable
  • (since 0.2) deploy Hemera Web module (if it is activated)
  • (since 0.2) install Hemera service (if corresponding option is used by a privileged user)


To setup Hemera:

HEMERA_ROOT_PATH/Hemera/scripts/setupHemera.sh


At any time, you can launch setup (e.g. after an upgrade, or if you have changed installation directory) with the -f option to force update/rewrite of files:

HEMERA_ROOT_PATH/Hemera/scripts/setupHemera.sh -f


Configure

To help configuring the whole of Hemera, a global configuration file system has been created.
For paths, you should read Binary and Library paths configuration first.

since v0.2

Create a configuration file, in your home directory, from the provided sample:

mkdir -p $HOME/.hemera
cp HEMERA_ROOT_PATH/Hemera/config/hemera.conf.sample $HOME/.hemera/hemera.conf

v0.1

Copy HEMERA_ROOT_PATH/Hemera/config/hemera.conf.sample to HEMERA_ROOT_PATH/Hemera/config/hemera.conf and adapt it to your configuration.
IMPORTANT: in this version, relative path are prefixed by HEMERA_ROOT_PATH/Hemera (meaning the thirdParty sub-directory must be specified)

Third-Party tools availability

See Install third-party tools.
Each third-party tool binary path, and data file path are checked when using corresponding core module.
A specific error message will be given in case of failure.