6.2 Windows: Installing and Setting Up a Basic Vibe Site

6.2.1 Performing Pre-Installation Tasks on Windows

Verifying System Requirements

Ensure that the Windows server where you plan to install Vibe meets the system requirements listed in Section 2.1, Vibe Server Requirements.

Stopping an Existing Web Server

If a web server is currently running on the Vibe server, stop it, and preferably disable it.

For example, to stop and disable the Internet Information Services (IIS) web server:

  1. On the Windows desktop, click Start > Administrative Tools > Services.

  2. Right-click World Wide Web Publishing Service, then click Properties.

  3. In the Startup type drop-down list, select Disabled.

  4. Click Stop, then click OK.

Setting Environment Variables

Ensure that the JAVA_HOME environment variable is set to the path where you installed the JDK and that the Windows PATH environment variable includes the path to your database server.

  1. Right-click My Computer, then click Properties.

  2. On the Advanced tab, click Environment Variables.

  3. Set the JAVA_HOME environment variable:

    1. In the System variables box, click New.

    2. In the Variable name field, specify JAVA_HOME.

    3. In the Variable value field, specify the path where you installed the JDK.

    4. Click OK to add the JAVA_HOME environment variable to the list of system variables, then click OK again to save the setting and return to the Advanced tab.

  4. Check the PATH environment variable:

    1. On the Advanced tab, click Environment Variables.

    2. In the System variables list, locate the PATH environment variable.

    3. If the path includes your database server software directory, click Cancel.

      or

      If the path does not include your database server software directory, add the directory, then click OK.

6.2.2 Running the Windows Vibe Installation Program

  1. Log in to the Windows server as a user with Administrator rights.

  2. In Windows Explorer, browse to the directory where you downloaded and extracted the Vibe software.

  3. Double-click the installer-teaming.exe file to start the Vibe installation program.

  4. Accept the License Agreement, then click Next.

    Windows Teaming Installation program Welcome page
  5. Click Next to accept the default of New installation.

    Installation Type page
  6. Click Next to accept the default of Basic.

  7. Use the information that you have gathered on the Basic Vibe Installation Summary Sheet to provide the information that the Vibe installation program prompts you for:

    The installation program stores the information that it gathers in the installer.xml file in the same directory where you started the installation program.

  8. After you have provided all the requested information, click Install to begin the Vibe installation.

  9. When the installation is complete, click Finish to exit the Vibe installation program.

    Information about the installation process is written to the installer.log file in the same directory where you ran the Installation program. If a problem arises during the installation, the installer.log file provides information that can help you resolve the problem.

  10. Continue with Section 6.2.3, Creating the Vibe Database.

6.2.3 Creating the Vibe Database

Before you can start Vibe, you need to create the Vibe database.

  1. If you haven’t done so already, install the database on the Vibe server.

    For single-server installations running on Windows, install either the MySQL/MariaDB or Microsoft SQL database. (For information about how to install the MySQL or MariaDB database on the Vibe server (on Windows), see Section A.3.2, MySQL or MariaDB on Windows).

    For more information about installing the database for a multi-server Vibe system, see Section 14.0, Creating the Vibe Database on a Remote Server.

  2. Change to the following directory in your Vibe installation:

    vibe_installation\temp-installer\db\scripts\sql

    This directory contains the following scripts for each database type (MySQL/MariaDB, Microsoft SQL, and Oracle):

    • mysql-create-empty-database.sql

    • Oracle-create-empty-database.sql

    • sqlserver-create-empty-database.sql

  3. (Optional) If you need to change the default database name from sitescape to something else, edit the .sql file for your database type to replace sitescape with the new name.

  4. Use the database utility for your database type to run the corresponding script for your database from the vibe_installation/temp-installer/db/scripts/sql directory:

    MySQL/MariaDB:

    mysql -uusername -ppassword < "mysql-create-empty-database.sql"

    Microsoft SQL:

    osql -Uusername -Ppassword -i sqlserver-create-empty-database.sql

    You can also use the script with the SQL Server Express Utility to create the database.

    Oracle:

    sqlplus "/ as sysdba"
    SQL>spool update-oracle.out;
    SQL>@oracle-create-empty-database
    SQL>quit;
    
  5. Change to the db directory in the Vibe installation:

    vibe_installation\temp-installer\db

    This directory contains the following properties files:

    • mysql-liquibase.properties

    • Oracle-liquibase.properties

    • sqlserver-liquibase.properties

  6. In a text editor, open the properties file that corresponds with your database type to make any of the following changes. Save and close the text editor when you are finished making changes.

    • Change the database user name and password for accessing the database.

    • (Conditional) Specify the IP address for the database if it is running on a remote server.

      You need to replace localhost with the IP address of the remote server.

    • (Optional) Change the name of the Vibe database (the default name of the Vibe database is sitescape, the name of the company that previously developed the Vibe software).

  7. In the same directory, execute the following command to create the database schema:

    manage-database.bat database_type updateDatabase

    For example, if you are using a Microsoft SQL database:

    manage-database.bat sqlserver updateDatabase

    NOTE:You can safely ignore the following Liquibase log messages:

    • Warning: modifyDataType will lose primary key/autoincrement/not null settings for mysql

    • Any messages that contain the words info: failure or info: failed, as long as they are associated with a type INFO message

  8. Start the Vibe server as described in Starting Vibe on Linux.

  9. For security reasons, delete the password that you specified in Step 7:

    1. Change to the following directory in your Vibe installation:

      cd /vibe_installation/temp-installer/db

    2. In a text editor, open the database script that corresponds with your database type to delete the password.

  10. Continue with Section 6.2.4, Performing Post-Installation Tasks on Windows.

6.2.4 Performing Post-Installation Tasks on Windows

Checking for Available Hot Patches

After you install Vibe, ensure that you check on the Vibe download site where you downloaded the Vibe software for any hot patches that might be available.

Running Vibe as a Windows Service

Removing Vibe as a Windows Service

The Vibe installation program creates a service.bat file that you can use to remove the Vibe service.

  1. In a Command Prompt window, change to the following directory:

    c:\Program Files\Novell\Teaming\apache-tomcat\bin\windows

  2. Use the following command to configure Vibe as a Windows service:

    service.bat remove Teaming

    This removes a service named Apache Tomcat Teaming.

Configuring Vibe as a Windows Service

The Vibe installation program created a service.bat file for configuring Vibe to run as a Windows service.

  1. In a Command Prompt window, change to the following directory:

    c:\Program Files\Novell\Teaming\apache-tomcat\bin\windows

  2. In the windows directory, copy the files from the appropriate subdirectory.

    The following subdirectories exist: x86, x64, ia64.

    If you are unsure which subdirectory is appropriate for your server, use the readme.txt file located in the c:\Program Files\Novell\Teaming\apache-tomcat\bin\windows directory as a reference.

  3. Paste the files into the c:\Program Files\Novell\Teaming\apache-tomcat\bin directory.

  4. Use the following command to configure Vibe as a Windows service:

    service.bat install Teaming

    This creates a service named Apache Tomcat Teaming.

Starting Vibe as a Windows Service

  1. On the Windows desktop, click Start > Administrative Tools > Services.

  2. Right-click Apache Tomcat Teaming, then click Start.

Configuring the Vibe Service to Start Automatically on Reboot

When you run Vibe as a Windows service, you can configure Vibe to start automatically each time you reboot the Windows server.

  1. On the Windows desktop, click Start > Administrative Tools > Services.

  2. Right-click Apache Tomcat Teaming, then click Properties.

  3. In the Startup type drop-down list, select Automatic, then click OK.

Restarting the Vibe Service

You need to restart Vibe whenever you use the Vibe installation program to make configuration changes, as described in Section 11.0, Performing an Advanced Vibe Installation.

  1. On the Windows desktop, click Start > Administrative Tools > Services.

  2. Right-click Apache Tomcat Teaming, then click Restart.

  3. Close the Services window.

Stopping the Vibe Service

  1. On the Windows desktop, click Start > Administrative Tools > Services.

  2. Right-click Apache Tomcat Teaming, then click Stop.

  3. Close the Services window.

Running Vibe as a Windows Application

Starting Vibe as an Application

The Vibe installation program created a startup.bat file for starting Vibe.

  1. In a Command Prompt window, change to the following directory:

    c:\Program Files\Novell\Teaming\apache-tomcat\bin

  2. Run the startup.bat file to start Vibe as an application.

Stopping Vibe as an Application

  1. In a Command Prompt window, change to the following directory:

    c:\Program Files\Novell\Teaming\apache-tomcat\bin

  2. Run the shutdown.bat file to stop the Vibe application.

Configuring the Document Converter on Windows

Kablink Vibe uses OpenOffice.org converters to prepare documents for indexing by the Lucene Index Server. The OpenOffice.org converters are also used on the Vibe site for converting documents to HTML for viewing.

Installing OpenOffice.org as the Document Converter for Vibe

  1. Download the OpenOffice.org software for Linux from OpenOffice.org to a convenient temporary location on the Vibe server.

  2. Run the downloaded executable, then click Next. to unpack the OpenOffice.org software.

  3. Browse to or select the destination directory for the unpacked files, then click Unpack.

    This starts the OpenOffice.org Installation program.

  4. Click Next to begin the installation.

  5. Provide your customer information, then click Next.

  6. Select Custom, then click Next.

  7. In the Optional Components drop-down list, select This feature, and all subfeatures, will be installed on local hard drive, then click Next.

    This includes the OpenOffice.org Java Runtime Environment (JRE) and other components required for document conversion.

  8. Click Install Now.

    The OpenOffice.org software is installed to:

    c:\Program Files\OpenOffice.org3

  9. Click Finish.

  10. Continue with Configuring OpenOffice.org for Proper HTML Conversion.

Configuring OpenOffice.org for Proper HTML Conversion

  1. Start OpenOffice.org from the desktop.

  2. Proceed through the Welcome pages.

  3. Click Tools > Options.

  4. Expand Load/Save, then click HTML Compatibility.

  5. In the Character Set field, select Unicode (UTF-8).

  6. Click OK to save the character set setting, then exit OpenOffice.org.

  7. Continue with Running OpenOffice.org as the Document Converter for Vibe.

Running OpenOffice.org as the Document Converter for Vibe

OpenOffice.org must be running as a background process on the Vibe server in order for indexing and viewing to take place for Vibe users.

  1. Edit the properties of the OpenOffice.org desktop icon so that the Target field includes the following additional options:

    "c:\Program Files\OpenOffice.org 3\program\soffice.exe"
          -accept="socket,host=localhost,port-8100;urp;
           StarOffice.Service"
          -nologo -headless
    
  2. Double-click the OpenOffice.org desktop icon to start OpenOffice.org as a background process.

    IMPORTANT:Run OpenOffice.org as a user that has full rights to the Vibe file repository.

  3. Use Windows Task Manager to observe that the soffice.exe and soffice.bin processes are running.

  4. Test HTML conversion on your Vibe site by viewing a document that has been added as a File Entry in your Vibe site.

  5. Configure the Vibe server so that OpenOffice.org is always running as a background process whenever Vibe is running.

Excluding File Types from Being Indexed and Displayed

After Vibe is installed and running, if OpenOffice is crashing with certain file types during either of the conversion processes, you can restrict the problematic file types from being converted.

For more information, see Understanding and Configuring Document Conversions with OpenOffice in the Kablink Vibe 4.0.1 Administration Guide

Uninstalling Vibe

If you move the Vibe site to a different server, you can delete the Vibe files from the original server to reclaim disk space. The default Vibe file locations are:

Vibe Software

c:\Program Files\Novell\Teaming

Vibe File Repository and Lucene Index

c:\Novell\Teaming

MS SQL Database

c:\Program Files\Microsoft SQL Server\MSSQL\Data

For a complete list of your Vibe files, check the installer.xml file in the directory where you originally ran the Vibe Installation program.