This document describes procedures for installing Borland AppServer on Suse Linux x86 32-bit operating system.
You can install Borland AppServer 6.6 from the CD or download Borland AppServer 6.6 from http://www.borland.com/downloads/download_appserver.html
Notes:
Before installing on Suse Linux you should:
Before installing Borland AppServer on Suse Linux check the platform, system, and JDK requirements.
The installation package on CD includes a bundled version of the Java Development Kit (JDK). However, if you are downloading Borland AppServer from the web, you need an existing JRE 1.4.2 and above in your environment in order to run the installer.
Important: Before installing on Suse Linux, you must have an existing JDK (1.4.2 is supported) installed. Make sure to put the JDK bin directory into the path variable.
For information about changing a Partition's JDK after you have completed the product installation, go to “Changing the JDK” in the “Using Partitions” section of the Management Console User's Guide.
To check the location of your JDK and the version, use the following syntax:
$which java /opt/local/bin/java $java -version java version "1.4.2"
The Borland AppServer CD includes installation software for the Suse Linux operating systems. This section describes how to prepare to install Borland AppServer on Suse Linux from CD.
# mount -t iso9660 -o ro /dev/cdrom /cdromwhere
/cdrom
represents the mount point of the CD-ROM.If you are using auto-mounting software, the CD-ROM is mounted automatically to the directory specified in your auto-mount configuration when you insert it into the CD-ROM drive. You can proceed with instructions given in Installing Borland AppServer.
To check if you have auto-mounting software, use the following command:
$ ps aux | grep automountIf you have auto-mounting software, the output should be similar to the following:
root 628 0.0 0.2 1148 588 ? S 17:32 0:00 /usr/sbin/automount
Go to root and enter the following command:
umount /cdrom
(if you have manually mounted the CD-ROM)
eject cdrom
(if you have used auto-mounting software to mount the CD-ROM)
You can install Borland AppServer from the CD or download the software from the Borland web site: http://www.borland.com/downloads/download_appserver.html
Before you install Borland AppServer, select the installation method:
To install Borland AppServer from a CD:
$ /cdrom/install_linuxwhere
/cdrom
is the directory where CD-ROM is mounted.
Important: Make sure the Mozilla (located at /usr/bin
) is in your path in order to use the default browser.
Note: To view Readme and installation documentation on the CD, or to browse the contents of the CD, click the appropriate entries on the splash screen.
For most options, defaults offered by the installation wizard are acceptable. You can use the Previous
button to return to earlier screens and change any information that is incorrect.
If installing from the web download:
.jar
file using chmod
command.java -cp <product name>-<release number>-linux-suse-x86.jar install
For most options, defaults offered by the installation wizard are acceptable. You can use the Previous
button to return to earlier screens and change any information that is incorrect.
Borland AppServer with Tibco: Installs the entire Borland Enterprise Server, which includes support for integrated management of Java Messaging Services (JMS) through Tibco.
Borland AppServer with OpenJMS: Installs the Borland AppServer, which includes support for integrated management of JMS through OpenJMS.
This creates a new installation of Borland Appserver in the folder you specified.
Important: You cannot install this version of Borland AppServer on top of previous releases.
Management Console: GUI and tools for managing services and Partitions. For information about installing only the Management Console, go to Installing a standalone Borland Management Console.
Server: All server components, such as the Partition, Apache Web server, JDataStore, and VisiBroker.
Client: Components for client applications (EJB client).
Documentation: Suite of online documentation.
Examples: Example applications for Borland Appserver.
In addition, the typical installation includes the following defaults:
osagent
port. This port is used by the ORB to communicate with the server. You can use the Management Console to change the Smart Agent port after installation is completed. The default is 14000
.
42424
.
Note: The value(s) you enter for the port(s) must be valid for the installation to proceed.
Note: If you select the default, you may have to manually add certain components to your environment path.
The typical installation does not add the VisiBroker environment variables to your system environment. If you choose the Custom install type to add the VisiBroker environment variables, the installation sets the BAS_LIC_DIR to
BES_LIC_DIR
to
<install_dir>/var
and BES_LIC_DEFAULT_DIR
to
<install_dir>/license
.
Previous
button to revisit and change any selections you made except your choice for which product to install.
Install
button.Next
. The Registration Wizard launches
in a separate window. After you dismiss the Registration Wizard, the
installer completion panel displays.
<install_dir>/license
directory. If you did not receive a license activation key file, or if you are reinstalling the software, go to http://www.borland.com/downloads/download_appserver and download a new license key.
Important: You must register and activate your
license in order to use the product. If you have a valid, node-locked license for the previous version of the
Borland AppServer on the same machine where you installed the latest Borland AppServer, use the lmadm
command-line tool to migrate your older license for use with the newly-installed Borland AppServer software.
Note: If you want to register and activate your license later, either by running the lmadm
executable found in the
<install_dir>/bin
directory or by launching the wizard from the Tools menu in the Management Console (see the Management Console User's Guide), choose "No" and click Next
.
Done
.The installer generates an install log that is written to the root of the installation directory if you installed Borland AppServer from CD, or to the folder where the installer file resides if you used a downloaded file to install Borland AppServer.
<install_dir>/Borland_AppServer_InstallLog.xml
The file is an XML formatted log with installation-specific information, such as errors.
Borland AppServer includes a graphical user interface, called the Management Console, which acts as the focal point for managing Agents and applications on your network.
The server typically runs on a large shared UNIX or Windows machine, while the Management Console runs on any machine from which users want to view or modify the distributed system. Once the Management Console is installed, you can deploy to any server on your network.
To install a standalone Management Console:
Custom
.If you install more than one instance of BAS on the same machine:
Note: We recommend you use the management console to change port ID numbers.
To change Management port numbers:
Properties
.To change Web container port IDs:
Properties
. The Properties tab Service:
HTTP/ node displays the connector attributes.For information about updating the Borland web container server.xml
, go
to "Web component" section in the BAS Developer's Guide.
/var/domains/base
and rename it, for
example you can call it base2 (/var/domains/base2)
/var/domains/base2/adm/
properties/agent.properties
to a unique name of your choice. (This is the name
assigned to the management agent)./var/domains/base2/
adm/properties/management_vbroker.properties
to a unique management port. (This is
the management port for the agent)scu -domain baseSimilarly to start with the settings as specified in base2 use
scu -domain base2.
The installer is capable of running in a text only mode for UNIX systems. You can invoke the installer with a parameter which specifies the UI mode.
To run the installer in text-only mode:
java -cp <install_file>.jar install -i console
The installer will write to stdout
and read from stdin
.
This allows you to telnet
from one system to another and run the installer remotely.
Before running VisiTransact, you need to set two license environment variables (BES_LIC_DIR
and BES_LIC_DEFAULT_DIR)
. During installation, a shell script is created for you to use for setting these environment variables.
To set the variables:
<install_dir>/bin
.If you are using the Korn or Bourne shell, use the following script to set environment variables:
vbroker.sh
If you are using the C shell, use the following script to set environment variables:
vbroker.csh
.profile
, .cshrc
, or .login
file.setuser
tool to manage ownership
Note: The setuser
tool replaces the functionality
provided by the iaschangeowner
script included in previous releases.
The setuser
tool manages ownership of Borland AppServer components installed on UNIX hosts.
The tool manages all aspects of ownership for these components, which includes:
For example, if you install the software as usernameA
but usernameB
is the intended user, you can use setuser
with the +o
option to change ownership of the appropriate components so usernameB
can start the SCU process (Agent) as intended.
For example, if you have Payroll, Legal, and Human Resources departmental applications
configured as separate MOs under the same Agent, you can use setuser
with the
+m
option to grant execution permissions for each application to mutually exclusive owners without exposing other Borland AppServer privileges to either owner. While Borland AppServer is running in MUM, each user has access to only the MOs they have permission to use.
The setuser
tool implements defense mechanisms to secure these components by
configuring the file system with appropriately restrictive ownership and access permissions.
Important: This tool must be run by a superuser, and all Borland AppServer processes must be stopped before running the tool. The superuser's current GID should be configured to be the same as the GID that was initially used to configure the MUM. The SCU process will fail to start if you invoke it as root but with a GID that is different than the one used to configure the MUM.
The setuser
tool is in your Borland AppServer installation's /etc/utils/
directory. Its usage is as follows:
setuser [-r <install-dir>] [-u <new-user>] [-g <new-group>] [+o|+m] [-h]
where
<install-dir>
is the root directory of the installation where the ownership changes are made. If not specified, the setuser
tool's own installation location is used.
<new-user>
is the new username for the installation (and, if enabling MUM, the default username that MOs started by the Agent run under).
<new-group>
is the new groupname for the installation (and, if enabling MUM, the default group name that MOs started by the Agent run under).
+o
changes the owner ID of the Agent and other Borland AppServer components to
<new-user>
and <new-group>
.
+m
changes the owner ID of the Agent and other Borland AppServer components to <new-user>
and <new-group>
while simultaneously enabling the application to run in MUM, allowing each MO started by the Agent to retain its configured ownership.
-h
displays usage information for the setuser
tool.
The +o
and +m
options are mutually exclusive: either use +o
to configure the installation to simply execute Borland AppServer components under a different owner, or use +m
to enable MUM.
The -u
and -g
options are optional.
/Borland/appserver
to usernameB
:
setuser -r /Borland/Appserver -u usernameB -g admins +o
setuser +m
setuser +o
Note: Subsequently running setuser
with the +o
option to change ownership after using the +m
option disables MUM. To enable MUM and change ownership of the installation at the same time, use the +m
option only (see Enabling multi-user mode).
When you need to change the ID an installation's Agent runs under, use the setuser
tool with the +o
option. The tool changes the owner ID and reconfigures the necessary file ownerships (log files, property files, configuration files, and so forth). For example:
setuser -r /borland/myBAS/ -u usernameC -g admins +ochanges the user and group under which the Borland AppServer installation
/borland/myBAS
executes to usernameC
and admins
, respectively. The +o
option tells the tool that the new user and group name will be used as the new owner ID of Borland AppServer.
To change ownership of the installation and its supporting files:
setuser
tool with the +o
option, specifying the username and groupname of a new owner. For example:
setuser -r /borland/myBAS/ -u usernameC -g admins +o
Important: If you are configuring a remote script or application to run under MUM, the MO user you specify in the Configuration must have appropriate permissions on the remote filesystem to load and execute the script or application. For security, other users should not have access to the remote script or application's filesystem.
Note: If you add or modify configurations under an Agent that
is already running in MUM, you need to rerun setuser
with the +m
option to enable the new or modified Configurations to run in MUM.
Multi-user mode configures Borland AppServer to securely support running MOs under multiple, differing user IDs. Enabling MUM is in many ways a special case of changing the user ID under which the Agent executes.
When MUM is enabled for an Agent, the SCU process for the Agent must be started by root. After the SCU process starts, the running process is owned by the specified Agent owner, while the processes for each MO are owned by the configured user for the MOs or applications. If a Configuration does not specify values for Start As User or Start As Group, the MO's processes are owned by the Agent's owner.
To enable MUM:
Properties
to launch the Properties editor.Settings
tab, then click More Settings
.Platform Specific Settings
tab.Start As Group
and Start As User
.OK
to save the changes and dismiss the Properties editor panels.setuser
with the +m
option, specifying the new owner ID (or omit the -u
and -g
flags to keep the existing owner ID). For example:
setuser -r /borland/myBAS/ -u usernameC -g admins +m
agent.config
(see Enabling Managed Objects to start as root).agent.config
(see Enabling JavaScript support when starting Managed Objects as root).The SCU process starts under root ownership but after starting, the process is owned by the existing owner of the Borland AppServer installation, or by the new owner ID specified by the -u
and -g
options. Each MO's processes are owned by the owners specified in their Configurations. If a Configuration does not specify values for Start As User or Start As Group, the MO's processes are owned by the Agent's owner.
Important: Enabling an MO to start as root might expose elevated privileges to unintended users, and should only be implemented for MOs that must be started as root to provide required functionality (for example, enabling Apache to allow privileged port access). To prevent accidental or malicious deployment of a root-started MO that might compromise system security, before enabling an MO to start as root, perform a security audit on the MO's executables and secure access to the system where the MO resides.
Tip:
To isolate potential security exposures and simplify administration efforts,
put all root-started MOs under one Agent and update its agent.config
file to allow
the MOs to start as root. Place all other MOs under a different Agent and leave its agent.config
file unchanged to retain the default Borland AppServer behavior to disallow starting MOs as root.
Typically, to protect against unauthorized access to MOs, the Agent is prevented from starting
an MO as root user. In rare cases, an MO might need to be started by root to function as intended.
To override builtin protection against root-started MOs after enabling Borland AppServer to run in MUM, you need to modify agent.config
to allow MOs to be started by root.
After the MO starts under root ownership, its process ownership is defined and configured by the MO or application (for example, the Apache owner specified in the httpd.conf
file), not by Borland AppServer.
To enable MOs to be started by a root user:
agent.mum.enable.root.mo
property in agent.config
(found in <install_dir>/var/domains/base/adm/properties
) as follows:
agent.mum.enable.root.mo=true
Important: Enabling JavaScript execution for an MO started by an Agent configured for MUM might expose your system to malicious code that can run with elevated privileges. When enabling JavaScript execution for such an MO, ensure that the JavaScript has been security audited and is protected from unauthorized user access.
JavaScript execution is typically not allowed when an MO is started by an Agent configured for MUM. If any of the MOs that will run in MUM contain JavaScripts, you need to modify agent.config
to allow those JavaScripts to run.
To enable JavaScript execution when MUM is enabled:
agent.mum.enable.jscript
property in agent.config
(found in <install_dir>/var/domains/base/adm/properties
) as follows:
agent.mum.enable.jscript=true
To disable MUM:
setuser
with the +o
option. For example:
setuser -r /borland/myBAS/ +o
agent.mum.enable.root.mo
property in agent.config
to false
.agent.mum.enable.jscript
property in agent.config
to false
(see Enabling JavaScript support when starting Managed Objects while in MUM).
The SCU process will start and run as the existing Borland AppServer owner ID (or the new owner ID specified by the -u
and -g
options). Any unique user ID information configured for individual MOs will be ignored, and the MOs are run under the Agent's owner ID.
Important: Using silent installation implies your consent to the BAS License Agreement.
Before using silent installation you should:
For Suse Linux, only JDK 1.5.0 is installed. For information on Java products for Suse Linux, go to Sun or IBM's website
Important: Before installing on Suse Linux, you must have an existing JDK (1.4.2 and 1.5.0 is supported)
installed. Make sure to put the JDK bin
directory into the path variable. To ensure that
you have the right JDK version installed, you can run the jdkpatchcheck
tool from the
prompt. Navigate to the
/jdkpatchcheckThe jdkpatchcheck script is located in
<BAS_HOME>/etc/utils
.
The optional JDK property (JVM_JDK_HOME)
sets the JDK path for BAS components that
host user application code, such as new Partitions (including the Standard Partition),
and the application client container, “VisiClient Container”. By default, the JDK used
will be JDK 1.5.0 which was packaged with the product, or in the case of Suse Linux, the
first JDK found in the PATH at the time that the installer is run.
For silent installation, the optional JVM_JDK_HOME
property is only used when you need to
set the JDK path to a JDK other than the default version.
Using a JDK other than the one installed with BAS may have unpredictable results. We
highly recommend you use the JDK included with the installer.
Important: Do not remove the JDK installation that JVM_JDK_HOME
points to before uninstalling BAS.
If you remove the installed JDK, the Uninstaller will not work, since the Uninstaller is
configured to use the JDK pointed to by the JVM_JDK_HOME
property.
Before invoking the silent installation process, you must first create a text file that contains the properties for configuration settings, such as install directory, server name and JDK home. Each property must be listed on its own line, terminated by a carriage return, with no blank spaces at the end of each line and no blank lines at the end of the file. See the Properties file for silent installation section for more information.
After creating the text properties file, save it as <propertiesfile>.txt
, where <propertiesfile>
is the filename prefix for your properties file. Now you can invoke the silent installation process using the values specified in the properties file(s).
Note: All properties and values are case-sensitive. When specifying directory and file paths, always use a forward slash.
The properties file is a plain text file, with each property listed on its own line, terminated by a carriage return, with no blank spaces at the end of each line and no blank lines at the end of the file. The properties can appear in any order in the file.
Properties File Contents for Silent Installation
Variable | Value |
---|---|
INSTALLER_UI | silent (required). The mode of installation. |
USER_INSTALL_DIR | <install_dir> (required). The full path name for the Borland AppServer product directory of your choice. For Suse Linux, the default installation directory is /opt/Borland/appserver . |
OSAGENT_PORT | (optional). Default is 14000 . |
SERVER_NAME | <server_name> (optional). A server name of your choice. Default is host name. This is the same as the Management Agent Name that is entered during a custom install. |
MANAGEMENT_PORT | (optional). Sets the Management Port. Default is 42424 . |
USER_SHORTCUTS | The required value is /dev/null . |
INSTALL_DOCS | (optional). Installs the suite of online documentation. Default is YES . |
INSTALL_EXAMPLES | (optional). Installs the example applications for Borland AppServer. Default is YES . |
INSTALL_TYPE |
AppServer — Installs Borland Appserver.
|
JMS_TYPE |
|
JVM_JDK_HOME | (optional). Sets the JDK path for BAS components that host user application code. The default is set to the location where the JDK included with BAS is installed. |
INSTALL_CONSOLE | (optional,) Installs the Management Console. Default is YES . |
INSTALL_SERVER | (optional). Installs all the server components, such as the Partition, Apache Web server, and JDataStore. Default is YES .
|
INSTALL_CLIENT | (optional). Installs all the components for EJB client applications. (Default is YES ). |
CONFIGURATION_SETUP | (optional). Installs the BAS example configuration. Default is YES . |
This example installs Borland Appserver on non-default management agent ports.
INSTALLER_UI=silent USER_INSTALL_DIR=/opt/Borland/appserver INSTALL_TYPE=appserver JMS_TYPE=TIBCO USER_SHORTCUTS=/dev/null OSAGENT_PORT=14925 MANAGEMENT PORT=42925 CONFIGURATION_SETUP=NO
To invoke the silent installation process using the values specified in the properties file:
chmod
all, where 777
indicates all, to run the installer.<propertiesfile>
file:
java -cp <installer file>.jar install -f <path to properties file>
where <path to properties file>
is the full path of the propertiesfile
file.
Note: After silent installation is completed, you need to register and activate the license you received for your product. The license may be in the form of an email from Borland listing one or more serial numbers and license keys, or it may be a license key file sent to you in an email from Borland. If you want to register and activate your license by running the lmadm
executable found in the <install_dir>/bin
directory or by launching the wizard from the Tools
menu in the Management Console (see the Management Console User's Guide).
Before using Borland AppServer, you need to register and activate the license you received for your product. The license may be in the form of an email from Borland listing one or more serial numbers and license keys, or it may be a license key file sent to you in an email from Borland.
If you have a valid, node-locked license for previous version of Borland AppServer installed on the same machine as the newly-installed Borland AppServer, use the lmadm
command-line tool to migrate your previous license for use with the newly-installed Borland AppServer 6.6 software
If you have already received a key file in an email from Borland for a product you purchased online or downloaded for evaluation, or if you downloaded a free version of the product, you can use the registration wizard to apply the key file, or you can copy it to the <install_dir>/license
directory and it will be applied automatically when you restart your product.
If you have a serial number and key, you can register and activate your Borland AppServer product using one of the following registration methods:
Depending on which method you choose, you may be asked to indicate whether you have a Borland Developer Network (BDN) account. If you do not have an account, you will be prompted to create one in the product registration wizard.
If you do not choose the Direct registration method, you will receive an activation file. Copy this file into the <install_dir>/license
directory and it will be applied automatically when you start your product.
To use the Borland product registration wizard for Direct registration:
Next
.Next
. If you do not have an account
you are prompted to create one in this wizard.Next
. The wizard monitors and
displays the progress of your registration.Next
. Then click Finish
to close the Wizard.To use the Borland product registration wizard for Email registration:
Next
.Next
. If you do not have an account
you are prompted to create one in this wizard.Next
.Next
.Finish
. You will receive a product activation file by email.<install_dir>/license
directory,
and it will be applied automatically when you start your product.To use the Borland product registration wizard for Web page registration:
Next
.Finish
to close the Wizard.Login
. If
you do not have an account, click the Create account
link (http://reg.borland.com/srs5/new_user.jsp).Continue
.Register
.
You will receive a product activation file by email.<install_dir>/license
directory,
and it will be applied automatically when you start your product.To use the Borland product registration wizard for Telephone registration:
Next
.Next
, then click Finish
to close the Wizard.<install_dir>/license
directory, and it will be applied
automatically when you start your product.To uninstall Borland AppServer:
osagent
) running during the uninstall.<install_root>/UninstallerData
directory.uninstall
command:
java -cp uninstaller.jar uninstall
[ -i console] #
for console mode.
Note: This does not remove files and folders that were created after the installation.
uninstall
command, check the installation directory and
remove any unnecessary files and subdirectories. Note: By default, the uninstallation happens in the same mode by which you have installed
For example., if you installed using silent installation, the uninstallation happens by silent mode. If you installed using GUI, you will have to uninstall using GUI.