Difference between revisions of "Graphical Installation"

From Recital Documentation Wiki
Jump to: navigation, search
(Peer)
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Welcome screen==
+
==Overview==
 +
Recital 10 products are distributed as a binary executable which contains all the products for that platform and allows one or more of them to be installed.
 +
 
 +
Recital products are available from the [http://www.recitalsoftware.com/index.php?option=com_jdownloads&Itemid=129 Downloads] area of the Recital web site.
 +
 
 +
For details of purchasing Recital licenses, please [mailto:sales@recitalsoftware.com contact Recital] or visit [http://www.recitalsoftware.com our web site].
 +
 
 +
==Text Installation==
 +
The installer will default to a ''text installation'' in non-graphical environments.  Text installation can also be selected by specifying the '''--mode text''' parameter when running the installer on the command line.  Please see [[Text Installation]] for instructions.
 +
 
 +
==Welcome Screen==
 
Click '''Forward''' to continue, '''Cancel''' to exit the installation.  In the following screens, you will also be able to click '''Back''' to return to the previous page.
 
Click '''Forward''' to continue, '''Cancel''' to exit the installation.  In the following screens, you will also be able to click '''Back''' to return to the previous page.
  
[[Image:ginstallation_welcome.jpg]]
+
[[Image:setup.png]]
  
 
==License Agreement==
 
==License Agreement==
 
Please read the license agreement, then select '''I accept the agreement''' or '''I do not accept the agreement''' and click '''Forward''' to continue.  If you do not accept the license agreement, the installation will terminate.
 
Please read the license agreement, then select '''I accept the agreement''' or '''I do not accept the agreement''' and click '''Forward''' to continue.  If you do not accept the license agreement, the installation will terminate.
  
[[Image:ginstallation_license.jpg]]
+
[[Image:setup-1.png]]
  
 
==Select Components==
 
==Select Components==
Line 14: Line 24:
 
===Recital===
 
===Recital===
  
[[Image:ginstallation_recital.jpg]]
+
[[Image:setup-2.png]]
  
 
===Recital Server===
 
===Recital Server===
  
[[Image:ginstallation_server.jpg]]
+
[[Image:setup-2a.png]]
  
 
===Recital Web===
 
===Recital Web===
  
[[Image:ginstallation_web.jpg]]
+
[[Image:setup-2b.png]]
  
 
===Recital Client Drivers===
 
===Recital Client Drivers===
  
[[Image:ginstallation_clients.jpg]]
+
[[Image:setup-2c.png]]
 
+
===Recital Replication===
+
 
+
[[Image:ginstallation_replication.jpg]]
+
  
 
Once you have selected your chosen components, click '''Forward''' to continue.
 
Once you have selected your chosen components, click '''Forward''' to continue.
Line 37: Line 43:
 
Please select the directory in which the Recital products should be installed.  The default directory is /opt/recital-''<version>'', where ''<version>'' is the version of the software.   
 
Please select the directory in which the Recital products should be installed.  The default directory is /opt/recital-''<version>'', where ''<version>'' is the version of the software.   
  
[[Image:ginstallation_instdir.jpg]]
+
[[Image:setup-3.png]]
  
 
To browse your file system, click on the folder button.  This will display the ''Select File'' dialog, allowing you to choose an existing folder or create a new one.
 
To browse your file system, click on the folder button.  This will display the ''Select File'' dialog, allowing you to choose an existing folder or create a new one.
  
[[Image:ginstallation_selectinstdir.jpg]]
+
[[Image:setup-select-file.png]]
  
 
Click '''OK''' to save your selection and return to the previous screen, '''Cancel''' to return leaving the installation directory setting unchanged.
 
Click '''OK''' to save your selection and return to the previous screen, '''Cancel''' to return leaving the installation directory setting unchanged.
  
[[Image:ginstallation_instdir.jpg]]
+
[[Image:setup-3.png]]
  
This screen also allows you to specify whether a Recital short cut icon should be created for all users or just you (root).  Once your selections are complete, click '''Forward''' to continue.
+
This screen also allows you to specify whether a Recital shortcut icon should be created for all users or just you (root).  Once your selections are complete, click '''Forward''' to continue.
  
 
==Environment==
 
==Environment==
 
You can choose to allow the installation to link certain important file into ''/usr/bin'' so they will be available without having to adjust your PATH setting.
 
You can choose to allow the installation to link certain important file into ''/usr/bin'' so they will be available without having to adjust your PATH setting.
  
[[Image:ginstallation_usrbin.jpg]]
+
[[Image:setup-4.png]]
  
 
Select '''Yes''' or '''No''' then click '''Forward''' to continue.
 
Select '''Yes''' or '''No''' then click '''Forward''' to continue.
Line 59: Line 65:
 
This screen is only displayed if you chose to install the Recital Client Drivers component.
 
This screen is only displayed if you chose to install the Recital Client Drivers component.
  
[[Image:ginstallation_odbc.jpg]]
+
[[Image:setup-5.png]]
  
  
Line 80: Line 86:
 
This screen is only displayed if you chose to install the Recital Client Drivers component.
 
This screen is only displayed if you chose to install the Recital Client Drivers component.
  
[[Image:ginstallation_jvm.jpg]]
+
[[Image:setup-jvm-selection.png]]
  
 
The installer checks to see if you have a Java Virtual Machine (JVM) installed and prompts you to select the JVM to be used by the Recital JDBC Driver.  Once you have made your selection, click '''OK''' to continue and your choice will be displayed.
 
The installer checks to see if you have a Java Virtual Machine (JVM) installed and prompts you to select the JVM to be used by the Recital JDBC Driver.  Once you have made your selection, click '''OK''' to continue and your choice will be displayed.
  
[[Image:ginstallation_jvmconfirm.jpg]]
+
[[Image:setup-6.png]]
  
 
Click '''Forward''' to continue.
 
Click '''Forward''' to continue.
Line 91: Line 97:
 
This screen is only displayed if you chose to install the Recital Client Drivers component.
 
This screen is only displayed if you chose to install the Recital Client Drivers component.
  
[[Image:ginstallation_tomcat.jpg]]
+
[[Image:setup-7.png]]
  
 
Click '''Forward''' to continue.
 
Click '''Forward''' to continue.
Line 98: Line 104:
 
This screen is only displayed if you chose to install the Recital Web component.
 
This screen is only displayed if you chose to install the Recital Web component.
 
    
 
    
[[Image:ginstallation_apache.jpg]]
+
[[Image:setup-8.png]]
  
 
The installer checks to see if you have Apache web server installed and prompts you to install the Recital Web plugin for Apache if so.  You can also specify to restart Apache after the installation to enable the plugin.  Recital Web can also run as a standalone web server, in which case the plugin is not required.  Once you have made your selection, click '''Forward''' to continue.
 
The installer checks to see if you have Apache web server installed and prompts you to install the Recital Web plugin for Apache if so.  You can also specify to restart Apache after the installation to enable the plugin.  Recital Web can also run as a standalone web server, in which case the plugin is not required.  Once you have made your selection, click '''Forward''' to continue.
  
==Replication Service Type==
+
==Install License File==
This screen is only displayed if you chose to install the Recital Replication component.
+
If you already have your license file, you can specify the name of the file here.  If not, you can [[License Installation|install the license]] after installation.
  
[[Image:ginstallation_reptype.jpg]]
+
[[Image:setup-9.png]]
  
 +
To browse your file system, click on the folder button.  This will display the '''Select File'' dialog, allowing you to find your license file.
  
* '''Slave''' - Select this type if this system will be a slave subscriber in a MSR (Master to Slave Replication) configuration.  There can be many slave subscribers but updates will only be performed from data published by the replication service.
+
[[Image:setup-select-file.png]]
* '''Master''' - Select this type if this system will be the master publisher in a MSR configuration. There can be only one master publisher and only updates on this system will be published for replication.
+
* '''Peer''' - Select this type if you are setting up a PPR (Peer to Peer Replication) configuration. In a PPR configuration all systems must be set to this type. This system will be able to publish all updates and subscribe to published updates from other systems.
+
  
===Slave===
+
Click '''OK''' to save your selection and return to the previous screen, '''Cancel''' to return without saving.
  
[[Image:ginstallation_slave.jpg]]
+
[[Image:setup-10.png]]
  
 +
Click '''Forward''' to continue.
  
'''Publisher'''
+
==Ready to Install==
Specify the node name or IP Address of the Publisher that this slave will subscribe to.  This should be the system that the Master replication service was installed on.
+
This is the final point at which you can cancel the installation.  If you are happy for the installation to proceed, click '''Forward''' to continue.
  
'''Delay'''
+
[[Image:setup-11.png]]
Specify the delay time in seconds that the service will pause between checking with the publication service.
+
  
===Master===
+
==Completing the Recital Setup Wizard==
 +
The following screen will be displayed once the installation completes.  Click '''Finish''' to exit.
  
[[Image:ginstallation_master.jpg]]
+
[[Image:setup-12.png]]
  
 +
To verify that Recital has installed correctly type:
  
'''Publication ID'''
+
<code lang="bash">
The publication ID is a unique number that is used to differentiate each system in the replication service.  For a master publisher it should be set to a value of 1.  This ID should not be changed once the replication service has been started on the system.
+
recital
 +
</code>
  
===Peer===
+
==Uninstall==
 +
Note:  The uninstaller must be run as root.
  
[[Image:ginstallation_peer.jpg]]
+
To uninstall Recital products, run the '''uninstall''' script in your chosen installation directory.
  
 +
[[Image:uninstall-1.png]]
  
'''Publication ID'''
+
Confirm uninstallation by clicking '''Yes'''
The publication ID is a unique number that is used to differentiate each system in the replication service.  The value must be set to a value greater than 1 and must not be the same as any other publication ID. This ID should not be changed once the replication service has been started on the system.
+
  
'''Publisher'''
+
[[Image:uninstall-2.png]]
Specify the node name or IP Address of the Publisher that you want to subscribe with.  You can specify the node name or IP Address of the system you are currently installing on.  Doing this will make this system the master publisher and you will need to provide a list of peers.
+
  
'''Delay'''
+
Optionally remove the Recital installation directory.
Specify the delay time in seconds that the service will pause between checking with the publication service.  If you have specified this system as the publisher, then it will also be used by the publication service.  
+
  
[[Image:ginstallation_peers.jpg]]
+
[[Image:uninstall-3.png]]
  
  
'''Replication Peers'''
+
==Configuration==
This option will be displayed if you have specified that this system will also be the publisher.  Please specify a comma-separated list of the node names or IP Addresses of the Peers that will publish.  You can specify the system you are installing on if you wish to publish it.
+
Please see the Configuration guide for your chosen product(s):
  
==Install License File==
+
* [[Configuration Files|Recital Configuration]]
If you already have your license file, you can specify the name of the file here.  If not, you can install the license after installation.
+
* [[Configuration Files|Recital Server Configuration]]
 +
* [[:Category:Recital Web Configuration|Recital Web Configuration]]
  
[[Image:ginstallation_licensefile.jpg]]
+
==Getting Started==
 +
Please see the Getting Started guide for your chosen product(s):
  
To browse your file system, click on the folder button.  This will display the '''Select File'' dialog, allowing you to find your license file.
+
* [[Recital Getting Started]]
 +
* [[Recital Server Getting Started]]
 +
* [[Recital Web Getting Started]]
  
[[Image:ginstallation_selectlicensefile.jpg]]
+
==Upgrading==
 +
Recital Corporation recommends that program files are recompiled and indexes rebuilt whenever a new version of the software is installed.  
  
Click '''OK''' to save your selection and return to the previous screen, '''Cancel''' to return without saving.
+
For additional upgrade instructions, please see [[Upgrading]].
 
+
[[Image:ginstallation_selectlicensefile.jpg]]
+
 
+
Click '''Forward''' to continue.
+
 
+
==Ready to Install==
+
This is the final point at which you can cancel the installation.  If you are happy for the installation to proceed, click '''Forward''' to continue.
+
 
+
[[Image:ginstallation_ready.jpg]]
+
 
+
==Completing the Recital Setup Wizard==
+
The following screen will be displayed once the installation completes.  Click '''Finish''' to exit.
+
  
[[Image:ginstallation_complete.jpg]]
+
[[Category:Documentation]]
 +
[[Category:Installation]]

Latest revision as of 12:47, 4 October 2010

Overview

Recital 10 products are distributed as a binary executable which contains all the products for that platform and allows one or more of them to be installed.

Recital products are available from the Downloads area of the Recital web site.

For details of purchasing Recital licenses, please contact Recital or visit our web site.

Text Installation

The installer will default to a text installation in non-graphical environments. Text installation can also be selected by specifying the --mode text parameter when running the installer on the command line. Please see Text Installation for instructions.

Welcome Screen

Click Forward to continue, Cancel to exit the installation. In the following screens, you will also be able to click Back to return to the previous page.

Setup.png

License Agreement

Please read the license agreement, then select I accept the agreement or I do not accept the agreement and click Forward to continue. If you do not accept the license agreement, the installation will terminate.

Setup-1.png

Select Components

Select the components you require. As you highlight each component, its description is displayed.

Recital

Setup-2.png

Recital Server

Setup-2a.png

Recital Web

Setup-2b.png

Recital Client Drivers

Setup-2c.png

Once you have selected your chosen components, click Forward to continue.

Installation Directory

Please select the directory in which the Recital products should be installed. The default directory is /opt/recital-<version>, where <version> is the version of the software.

Setup-3.png

To browse your file system, click on the folder button. This will display the Select File dialog, allowing you to choose an existing folder or create a new one.

Setup-select-file.png

Click OK to save your selection and return to the previous screen, Cancel to return leaving the installation directory setting unchanged.

Setup-3.png

This screen also allows you to specify whether a Recital shortcut icon should be created for all users or just you (root). Once your selections are complete, click Forward to continue.

Environment

You can choose to allow the installation to link certain important file into /usr/bin so they will be available without having to adjust your PATH setting.

Setup-4.png

Select Yes or No then click Forward to continue.

ODBC Installation Type

This screen is only displayed if you chose to install the Recital Client Drivers component.

Setup-5.png


The installer checks to see if you already have an ODBC Driver Manager installed and gives the following defaults:

  • Install the Recital ODBC driver for unixODBC Driver Manager. - If you already have the unixODBC Driver Manager installed.
  • Install the Recital ODBC driver for iODBC Driver Manager. - If you already have the iODBC Driver Manager installed.
  • Don't install the Recital ODBC driver now, do it manually later. - If you do not have a Driver Manager installed.


You can also get the choose to install the unixODBC Driver Manager:

  • Install the unixODBC Driver Manager with the Recital ODBC driver.

Once you have made your selection, click Forward to continue.

JVM Selection

This screen is only displayed if you chose to install the Recital Client Drivers component.

Setup-jvm-selection.png

The installer checks to see if you have a Java Virtual Machine (JVM) installed and prompts you to select the JVM to be used by the Recital JDBC Driver. Once you have made your selection, click OK to continue and your choice will be displayed.

Setup-6.png

Click Forward to continue.

TomCat Installation Type

This screen is only displayed if you chose to install the Recital Client Drivers component.

Setup-7.png

Click Forward to continue.

Apache plugin Installation

This screen is only displayed if you chose to install the Recital Web component.

Setup-8.png

The installer checks to see if you have Apache web server installed and prompts you to install the Recital Web plugin for Apache if so. You can also specify to restart Apache after the installation to enable the plugin. Recital Web can also run as a standalone web server, in which case the plugin is not required. Once you have made your selection, click Forward to continue.

Install License File

If you already have your license file, you can specify the name of the file here. If not, you can install the license after installation.

Setup-9.png

To browse your file system, click on the folder button. This will display the 'Select File dialog, allowing you to find your license file.

Setup-select-file.png

Click OK to save your selection and return to the previous screen, Cancel to return without saving.

Setup-10.png

Click Forward to continue.

Ready to Install

This is the final point at which you can cancel the installation. If you are happy for the installation to proceed, click Forward to continue.

Setup-11.png

Completing the Recital Setup Wizard

The following screen will be displayed once the installation completes. Click Finish to exit.

Setup-12.png

To verify that Recital has installed correctly type:

recital

Uninstall

Note: The uninstaller must be run as root.

To uninstall Recital products, run the uninstall script in your chosen installation directory.

Uninstall-1.png

Confirm uninstallation by clicking Yes

Uninstall-2.png

Optionally remove the Recital installation directory.

Uninstall-3.png


Configuration

Please see the Configuration guide for your chosen product(s):

Getting Started

Please see the Getting Started guide for your chosen product(s):

Upgrading

Recital Corporation recommends that program files are recompiled and indexes rebuilt whenever a new version of the software is installed.

For additional upgrade instructions, please see Upgrading.