Difference between revisions of "Installation/Installation Guide"

From DAFWiki
Jump to: navigation, search
m (Administrator moved page Installation Guide to Installation/Installation without leaving a redirect)
m
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
  
[[Installation Guide]]
+
[[media:InstallationGuide.pdf|Installation Guide]]
  
 
== System Prerequisites ==
 
== System Prerequisites ==
Line 9: Line 9:
 
== System Installation ==
 
== System Installation ==
 
Follow the following steps:
 
Follow the following steps:
* Download system binaries from the site ( DAFv2 Binaries)
+
* Download system binaries from the site ( [[media:DAFv2.bin.zip|DAFv2 Binaries]])
 
* Unzip the file DAFv2.bin.zip (ex. X:\DAFv2.bin)
 
* Unzip the file DAFv2.bin.zip (ex. X:\DAFv2.bin)
 
* Use the command line to change the working directory to the extracted folder (X:\DAFv2.bin)
 
* Use the command line to change the working directory to the extracted folder (X:\DAFv2.bin)
Line 18: Line 18:
 
Both modes are described in details in following subsections
 
Both modes are described in details in following subsections
  
== Batch Mode ==
+
=== Batch Mode ===
  
 
You can pass all arguments to DAFv2Installer.jar in one step; DAFv2Installer.jar has options representing each of installations keys described in table 1.2.
 
You can pass all arguments to DAFv2Installer.jar in one step; DAFv2Installer.jar has options representing each of installations keys described in table 1.2.
Line 131: Line 131:
  
  
== Interactive Mode ==
+
=== Interactive Mode ===
  
 
* Run DAFv2Installer.jar as following
 
* Run DAFv2Installer.jar as following

Latest revision as of 08:30, 13 May 2015

Installation Guide

System Prerequisites

  1. MySQL database engine 5.1 or later versions. Make sure the innoDB engine is active.
  2. Java Runtime Environment 5 or later.

System Installation

Follow the following steps:

  • Download system binaries from the site ( DAFv2 Binaries)
  • Unzip the file DAFv2.bin.zip (ex. X:\DAFv2.bin)
  • Use the command line to change the working directory to the extracted folder (X:\DAFv2.bin)
  • Use the DAFv2Installer.jar to setup the system. DAFv2Installer can work into two modes
    • Batch Mode
    • Interactive Mode
  • Make sure the log file "log.txt" in DAFv2.bin folder ends with "Installation process done successfully"

Both modes are described in details in following subsections

Batch Mode

You can pass all arguments to DAFv2Installer.jar in one step; DAFv2Installer.jar has options representing each of installations keys described in table 1.2. Ex. java –jar DAFv2Installer.jar –salt abc –dbroot root …etc. This command will set the salt key to “abc” and DB admin to “root”. The following table illustrates all options.


Option Key Description Mandatory
Table1 installation Options
-salt Salt Key Encryption in DAFv2 has two keys; the salt key is one of them.
Admin can choose any salt key in installation, this value will be used all over DAFv2.
salt key must be 8 characters length.
Yes
-dbroot DB admin When admin installs MySQL database engine, he should create a full
privileged User like “root” for example,this user is the DB admin.
Yes
-rootpwd DB admin PWD The password of DB admin Yes
-dbserver DB server IP The IP or server name which holds the database engine, this values
used by installer with the DB admin credentials in order to
install DAF02 schema. i.e. 172.16.0.43 is the IP of the Database server
Yes
-dbport DB server port The port of MySQL database, the default value is 3306. You should make
sure that this port is opened through your firewall (if exists)
Yes
-dbusr DB User DAFv2 is not using root account_ as default user _ for reading/writing
in DAF02 database, instead it creates a simple user
with execute and select privileges only. DB user represents this simple user.
Yes
-dbpwd DB Password: The password of DB user Yes
-bkip Backup Server IP DAFv2 need a server to save jobs the finished backup phase; this server
could be your workflow storage server. For safety sake,
we recommend to separate the workflow storage server and backup server.
Yes
-bkusr Backup Server User Name User with read/write access on the backup server. Yes
-bkpwd Backup Server User Password: The password of backup server user. Yes
-domname Domain Name This key used in LDAP authentication, it represent the name of you domain.
If you don not need to use authentication through
LDAP you an ignore the this value
No
-domip Domain IP The IP of your domain controller. No
-ldaport LDAP Port The port used by LDAP, default is 389 No
-actdir IsActiveDirectory If your LDAP server is Active Directory then you should type 1, otherwise type 0. No
-bindbase BindBase The bind base of LDAP server. Ex. dc=local,dc=bibalex,dc=dom No
-searchbase SearchBase The serach base in LDAP server. Ex. dc=local,dc=bibalex,dc=dom No


Interactive Mode

  • Run DAFv2Installer.jar as following

java –jar DAFv2Installer.jar

  • In the shell, DAFv2Installer.jar will start responding to you by enquiring you to enter some values. Some of theses values are obligatory and some are optional.

Use table2 to understand the functionality of each keys.

Key Description Mandatory
Table2 installation keys
Salt Key Encryption in DAFv2 has two keys; the salt key is one of them.
Admin can choose any salt key in installation, this value will be used all over DAFv2.
salt key must be 8 characters length.
Yes
DB admin When admin installs MySQL database engine, he should create a full
privileged User like “root” for example, this user is the DB admin.
Yes
DB admin PWD The password of DB admin Yes
DB server IP The IP or server name which holds the database engine, this values
used by installer with the DB admin credentials in order to
install DAF02 schema. i.e. 172.16.0.43 is the IP of the Database server
Yes
DB server port The port of MySQL database, the default value is 3306. You should
make sure that this port is opened through your firewall (if exists)
Yes
DB User DAFv2 is not using root account_ as default user _ for reading/writing
in DAF02 database, instead it creates a simple user with
execute and select privileges only. DB user represents this simple user.
Yes
DB Password: The password of DB user Yes
Backup Server IP DAFv2 need a server to save jobs the finished backup phase; this server
could be your workflow storage server. For safety sake,
we recommend to separate the workflow storage server and backup server.
Yes
Backup Server User Name User with read/write access on the backup server. Yes
Backup Server User Password: The password of backup server user. Yes
Domain Name This key used in LDAP authentication, it represent the name of you domain.
If you don not need to use authentication through LDAP you an ignore the this value
No
Domain IP The IP of your domain controller. No
LDAP Port The port used by LDAP, default is 389 No
IsActiveDirectory If your LDAP server is Active Directory then you should type 1, otherwise type 0. No
BindBase The bind base of LDAP server. Ex. dc=local,dc=bibalex,dc=dom No
SearchBase The serach base in LDAP server. Ex. dc=local,dc=bibalex,dc=dom No