Alfresco-Ingres Installation Bundle for Ingres 2006 Release 3

6.0 Contacting the Community

1.0 Welcome

Welcome to the "Alfresco-Ingres" installation. The installation bundle contains the Alfresco 2.1 and the Ingres 2006 Release 3 community editions for Linux environments.

This readme contains important information about the installation of Ingres with Alfresco using the installer provided by Ingres Corporation. This readme also describes how to contact the Ingres community and provides strategic references to the Ingres documentation. For more information, please visit the Ingres website at http://ingres.com/.

In the Windows version of the Ingres Alfresco Community Bundle we have addressed a number of generic issues that have been raised against the original Linux release.

1.1 New Features in the Installer for this build

• Typical Installation

  This option will auto detect all settings where possible and only prompt for user input when required.

• Custom Installation

  When using the custom installation procedure, the wizard will lead you through several screens requesting port information. The ports that you enter must be between 1024 and 64000 and not be used by other services. To ensure that all ports that may be required are available, follow the guideline below.

• Concurrent Installations and Services

  The Installer attempts to detect ports that are in use by other applications. To ensure that the installation wizard is not start before all required applications are running, we have added an initial screen to ask you if you need to start any additional applications before continuing with the install.

  You need to ensure that all instances of Ingres and Alfresco that are required to run concurrently are started before the installer is used to install additional instances of the Ingres Alfresco bundle. This is to allow auto-detection of in-use ports.

2.0 System Requirements

2.1 Linux

• Typical Installation:

  To install Ingres and enable a satisfactory Alfresco ECM environment, the following minimum requirements must be met:

• On installations with less than a 256 MB shared memory segment, Ingres will fail to start and the Alfresco database will not be created. To avoid this problem, use the following values:

  kernel.shmall = 2097152
  
  kernel.shmmax = 2147483648
  

• The minimum free disk space required for an evaluation installation that will provide a usable amount of space for Ingres and Alfresco to install, and for user content to be loaded, is 5 to 10 GB. No recommendations are provided for a production environment as the requirement will depend on the individual needs of the organization.

2.2 Windows

• Typical Installation:

  To install Ingres and enable a satisfactory Alfresco ECM environment, the following minimum requirements must be met:

• On installations with less than a 1GB of memory, Ingres may fail to start depending on other applications that are running. To avoid this problem we recommend using use the following values:

  physical memory should be at least 1GB 
  
  the pagefile size should be pre-allocated to at least 3GB. 
  

• The minimum free disk space required for an evaluation installation that will provide a usable amount of space for Ingres and Alfresco to install, and for user content to be loaded is 3 to 5 GB. No recommendations are provided for a production environment as the requirement will depend on the individual needs of the organization.

3.0 Installation Considerations

3.1 Linux:

The following tools or packages must be installed with your Linux distribution.

Development tools required:

• gcc

Notes:

• The gcc tool is required for this Alfresco-Ingres bundle, which is shipped with the Ingres Community edition ii9.2.0(int.lnx/118) NPTL. The gcc tool is not required with Ingres ii9.2.0(int.lnx/127) NPTL.

3.2 Windows:

Development tools required:

• No special tools are required.

Notes:

• The Ingres Transaction log has been reduced in the Windows installation from the production sized 1.9 GB to a size that is manageable on most Windows systems having 1 GB of memory.

• The locking and logging parameters have been reduced on the Windows installer to ensure that the Memory restrictions on the Windows machines are not exceeded.

3.3 Installing the Alfresco-Ingres Installation Bundle

To install in Linux environments

1. Log on to your system using the user account that will own the installation. This must not be the root user.

2. Download the self-installing installation image Ingres-Alfresco-2.1.0-5-linux-installer.bin.

3. Change to the directory that the installer was downloaded to:

   cd /home/user_account
   

4. Depending on the operating system, you may have to change the properties of the file using the following command:

   chmod 777 Ingres-Alfresco-2.1.0-5-linux-installer.bin
   

5. Start the installation by running the self-installing image:

   ./Ingres-Alfresco-2.1.0-5-linux-installer.bin
   

6. Follow the steps provided by the installation wizard.

7. Start the installation:

   1. Change to the root directory where the Alfresco-Ingres files were installed. Assuming the current user directory, issue the following command:

      cd /home/user_account/Ingres-Alfresco-2.1.0.5
      

   2. Start the Alfresco-Ingres installation using the control script, which starts Ingres first, and then Alfresco:

      sh ctlscript.sh start
      

   Starting the Alfresco-Ingres installation the first time initializes the Alfresco environment. Startup may take several minutes depending on the server.

Notes:

• The included Tomcat application container is configured to use the connection port 8080 by default. If other servers are running on this port, an optional screen is displayed that must be completed to enable the installer to continue using user-defined ports.

  In addition, Tomcat control ports must also be manually configured. By default, these are 8005 and 8009.

• The included Alfresco application container is configured to use an integral FTP service on connection port 2121 by default. If this port is not available, an optional screen is displayed that must be completed to enable the installer to continue using a user-defined port.

• Alfresco requires a port itself. To have more than one Alfresco installation on one machine, each installation requires its own RMI port. The included Alfresco application container is configured to use the RMI connection port 50500 by default. If this port is not available, an optional screen is displayed that must be completed to enable the installer to continue using a user-defined port.

• By default Ingres is configured to use the installation identifier AF. If there is already an Ingres installation using this identifier, choose an alternative identifier during the installation.

To install in Windows environments

1. Log on to your system using the user account that will own the installation. This must not be a networked user account.

2. Download the self-installing installation image Ingres-Alfresco-2.1.0-15-windows-installer.exe.

3. Open the folder that the installer was downloaded to.

4. Start the installer wizard by running the self-installing image.

5. Follow the steps provided by the installation wizard.

6. Starting the installation:

   The installation will automatically start as a service and after a short delay will be available by going to your browser and entering the following url:

   http://127.0.0.1:8080/alfresco
   

   If you provided a different tomcat port then replace the default 8080 shown above with the value that you provided.

Starting the Alfresco-Ingres installation the first time initializes the Alfresco environment. Startup may take several minutes depending on the server.

Notes:

• The included Tomcat application container is configured to use the connection port 8080 by default. If other servers are running on this port or the custom installation option was chosen, a port entry screen is displayed that must be completed to enable the installer to continue using user-defined ports.

  In addition, Tomcat control ports must also be manually configured. By default, these are 8005 and 8009.

• The included Alfresco application container is configured to use an integral FTP service on connection port 2121 by default. If this port is not available or the custom option was chosen, a port entry screen is displayed that must be completed to enable the wizard to continue using user-defined ports.

• Alfresco requires an RMI port itself. To have more than one Alfresco installation on one machine, each installation requires its own RMI port. The included Alfresco application container is configured to use the RMI connection port 50500 by default. If this port is not available or the custom option was chosen, a port entry screen is displayed that must be completed to enable the wizard to continue using a user-defined port.

• By default Ingres is configured to use the installation identifier AF. If there is already an Ingres installation using this identifier, choose an alternative identifier during the installation.

3.4 Uninstalling the Alfresco-Ingres Installation

To Uninstall the bundle in Linux environments

The Alfresco-Ingres installation can uninstalled by shutting down the installation and deleting the installation's root directory and installed files.

A script named "uninstall" is provided for this purpose in the installation root directory.

To uninstall manually

1. Log on to your system as the user that owns the installation.

2. Change to the installation directory:

   cd /home/user_account/Ingres-Alfresco-2.1.0.5
   

3. Stop your installation.

   sh ctlscript.sh stop
   

4. Change to one directory above the installation directory and install directory:

   cd..
   
   rm –rf Ingres-Alfresco-2.1.0.5
   

Notes:

• Stopping the installation may take a few minutes. Before removing the directory we recommend that you make sure that the installation is stopped. This command will return an empty list of processes:

  ps –elf | grep '<'  | grep –v 'grep'
  

To uninstall in Windows environments

The Alfresco-Ingres installation can uninstalled by shutting down the installation using the Start-Menu item Ingres and Alfresco Community Bundle Uninstall

Start->
Programs->
Ingres and Alfresco Community Bundle->
Ingres and Alfresco Community Bundle AF->
Ingres and Alfresco Community Bundle Uninstall
 

To uninstall manually

1. Log on to your system as the user that owns the installation.

2. Using either the files explorer or a command window locate the root folder for the Ingres Alfresco bundle that you are uninstalling.

3. If not already done so, open an Ingres command window and change to the installation directory:

   Start->
   Programs->
   Ingres->
   Ingres AF->
   Ingres Command Prompt
    
   

4. Stop your installation:

    servicerun.bat stop
   

5. To uninstall the Ingres and Alfresco bundle run the uninstall.exe program:

    uninstall.exe
   

Notes:

• Stopping the installation may take a few minutes. We recommend that you make sure that the installation is stopped before uninstalling. This can be done by attempting to access the Alfresco URL (see above)

4.0 Configuring Your Ingres Installation

The Alfresco-Ingres installation has been configured and installed for evaluation purposes. If you want to use your Ingres installation for production, some configuration changes—especially those related to the number of available locks on database objects—may be necessary. Further details can be found in the Ingres online documentation.

4.1 Ingres Online Documentation References

Links to relevant Ingres configuration details in the online documentation are provided here:

http://docs.ingres.com/dba/UnderstandingtheLockingSystem

http://docs.ingres.com/dba/HashStorageStructure
http://docs.ingres.com/cmdref/cbfCommandStartConfigurationByForms
http://docs.ingres.com/sysadm/ConfiguringIngres
http://docs.ingres.com/sysadm/LockingSystemConfiguration

5.0 Known Issues

Issues identified during the testing of the Alfresco-Ingres installation bundle are documented here.

5.1 Ingres Related Issues

• (GENERIC) If Ingres is using the UTF8 character set, the maximum size of text (varchar, byte varying, ...) columns is 16K instead 32K. The Alfresco repository database was adapted to take this into account.

• (LINUX) Ingres installation fails because of issues related to re-linking the server if using the latest version of Ubuntu. Later versions of Ingres 2006 Release 3 do not require the server to be re-linked.

• (WINDOWS) Cannot install as a Network login. The authentication function does not currently support network logins that have authority to act as part of the operating system.

• (WINDOWS) If Ingres fails to start, the installer may hang. If the resources on the server upon which the installation is being attempted are insufficient to start Ingres, the installer may hang and the processes will need to be manually stopped.

• (WINDOWS) When confirming a port that is actually in use (during custom installation or when used port detected), after the appropriate message the installer screen may alter itself for a few seconds ('flicker').

• (WINDOWS) In the Windows 'Add or Remove Programs' control panel there is only one link to the Ingres-Alfresco Community Bundle when multiple instances are installed. The instances can be uninstalled separately using the uninstall link in their respective start menu folder.

5.2 Operating System Related Issues:

Linux Environment

• Shared memory should be configured to have approximately 256 MB of memory available. Tests with Ubuntu show that it is configured for less than 256 MB by default. In this case, the kernel parameter shmmax should be set to a minimum 268435456 bytes of shared memory.

• Attempting to install as the root user will fail. The Ingres-Alfresco Bundle has been designed to install as a not-priviledged user.

Windows Environment

• If you are currently using a default installation of the Linux Ingres Alfresco bundle you may see a difference in the size of some tables (notably alf_node_properties). The reduction in size will not affect testing scenarios, but you are advised to read the Ingres Database Administrators Guide on the maintenance of HASH tables.

5.3 Alfresco Related Issues

• Alfresco comes with its own JAVA-implemented FTP and CIFS server. It has been reported that they are not working out of the box if your machine already runs an FTP server, a CIFS/Samba-server, a firewall, or the user that starts the installation does not have enough permissions to bind the related ports.

6.0 Contacting the Community

For online technical assistance from our community, please visit http://community.ingres.com , where you can find Forums, the Ingres Community Wiki, contacts, and mailing lists.