Chapter 1 Installing Oracle GlassFish^TM Server 3.0.1

This chapter provides instructions for installing Oracle GlassFish Server 3.0.1 and GlassFish Server Open Source Edition 3.0.1 on Solaris^TM, Linux, Mac OS X, and Windows systems.

The following topics are addressed:

• Installation Requirements

• Installation Files for GlassFish Server 3.0.1

• Using GlassFish Server ZIP File Installation

• Using GlassFish Server GUI Installation

• Using GlassFish Server Silent Mode Installation

• Installation Command-Line Options

Installation Requirements

Ensure that your system meets the requirements listed in Hardware and Software Requirements in Oracle GlassFish Server 3.0.1 Release Notes. Problems are likely to arise if you attempt to install on a platform that is not supported or on a system that in some other way does not meet release requirements. Also see Known Issues in Oracle GlassFish Server 3.0.1 Release Notes for known issues related to installation.

GlassFish Server 3.0.1 requires JDK^TM release 6. The minimum (and certified) version of the JDK software that is required for GlassFish Server depends on the operating system:

• For supported operating systems except Mac OS X, the minimum required version is 1.6.0_17.

• For the Mac OS X operating system, the minimum required version is 1.6.0_15.

If necessary, download and install the required JDK software.

On Solaris, Linux, and Windows systems, JDK software is available from the Java SE downloads page.

For Mac OS X systems, GlassFish Server uses the JDK that is part of the Macintosh operating system. If necessary, obtain the required JDK version from the Mac OS X Updates site.

Installation Files for GlassFish Server 3.0.1

The following topics are addressed here:

• GlassFish Server Download Locations

• GlassFish Server Installation Methods

• GlassFish Server ZIP Files

• GlassFish Server Self-Extracting Bundles

GlassFish Server Download Locations

GlassFish Server Installation files are available by download from the following locations:

• Oracle GlassFish Server product page

• GlassFish Server Community site

GlassFish Server 3.0.1 is also part of the Java EE 6 SDK distributions. The SDK distributions are available from the Java EE downloads page and are not described in this document.

After downloading the installation file, set JAVA_HOME and $JAVA_HOME/bin in the PATH to point to the supported JDK version.

GlassFish Server Installation Methods

Table 1–1 lists the various GlassFish Server installation methods. The table also provides links to installation instructions for each method.

GlassFish Server ZIP Files

The GlassFish Server multi-platform ZIP files are compatible with Solaris, Linux, Mac OS, UNIX, and Windows operating systems. See GlassFish Server Download Locations for a list of download locations.

Table 1–2 lists the available ZIP file downloads.

For more information about profiles, see Support for Java EE Profiles in Oracle GlassFish Server 3.0.1 Release Notes.

GlassFish Server Self-Extracting Bundles

The GlassFish Server self-extracting bundles are platform-specific, and are available for Solaris, Linux, Mac OS, UNIX, and Windows operating systems. See GlassFish Server Download Locations for a list of download locations.

Table 1–3 lists the available self-extracting bundles.

For more information about profiles, see Support for Java EE Profiles in Oracle GlassFish Server 3.0.1 Release Notes.

Using GlassFish Server ZIP File Installation

This section describes how to install GlassFish Server 3.0.1 using the multi-platform ZIP file. GlassFish Server is installed by unzipping the file in the installation directory of your choice.

To Install GlassFish Server Using the ZIP File

Before You Begin

Ensure that your system meets the requirements listed in Hardware and Software Requirements in Oracle GlassFish Server 3.0.1 Release Notes.

Also see Known Issues in Oracle GlassFish Server 3.0.1 Release Notes for known issues related to installation.

1. Download the desired GlassFish Server 3.0.1 ZIP file.

   See GlassFish Server Download Locations for a list of download locations. See Table 1–2 for a list of available ZIP files.

2. Change to the directory where you downloaded the ZIP file.

3. Unzip the file.

   • Solaris, Linux, and Mac OS X systems:

     unzip zip-file-name

     zip-file-name is the name of the file that you downloaded.

     For example:

     unzip ogs-3.0.1-unix.zip

   • Windows systems:

     Unzip using your favorite file compression utility.

   GlassFish Server 3.0.1 is installed into a new glassfishv3 directory under your current directory.

4. (Optional) Start GlassFish Server using the instructions in the Oracle GlassFish Server 3.0.1 Quick Start Guide.

   The guide explains how to perform basic tasks such as starting the server, accessing the Administration Console, and deploying a sample application.

Using GlassFish Server GUI Installation

This section describes how to install GlassFish Server 3.0.1 using the self-extracting installation program. GlassFish Server is installed using a GUI-based installation wizard.

Console installation is not supported in this release. Silent mode installation is available, however. For more information, see Using GlassFish Server Silent Mode Installation.

To Install GlassFish Server Using the Self-Extracting File

Before You Begin

Ensure that your system meets the requirements listed in Hardware and Software Requirements in Oracle GlassFish Server 3.0.1 Release Notes.

Also see Known Issues in Oracle GlassFish Server 3.0.1 Release Notes for known issues related to installation.

1. Download the desired GlassFish Server 3.0.1 bundle.

   See GlassFish Server Download Locations for a list of download locations. See Table 1–3 for a list of available self-extracting bundles.

2. Change to the directory where you downloaded the self-extracting file.

3. Start the installer.

   • Solaris, Linux, and Mac OS X systems:

     1. If necessary, grant execute permissions to the self–extracting file:

        chmod +x ./self-extracting-file-name

        self-extracting-file-name is the name of the self-extracting file that you downloaded.

     2. At the command prompt, type:

        self-extracting-file-name

        For example, start the installer by typing the following:

        ogs-3.0.1-unix.sh

   • Windows systems:

     1. Double-click the executable .exe installation file.

        For example, double-click:

        ogs-3.0.1–windows.exe

        On Windows you can also start the installer by typing the file name at the command prompt.

   ---

   Note –

   Additional setup options are available. See Installation Command-Line Options.

   If you are installing on a 64–bit Windows system, run the installer with the -j option pointing to a 64–bit JDK.

   ---

   After starting the installer, the Welcome page is displayed. Use the Next button to move through the installation process.

4. Respond to the license agreement, if required.

5. Specify where to install GlassFish Server.

   The default installation directory is as follows:

   • Solaris, Linux, and Mac OS X systems: user's-home-directory/glassfishv3

   • Windows systems: SystemDrive:\glassfishv3

   The default installation directory is referred to as as-install-parent throughout GlassFish Server documentation.

6. Specify administration settings.

   • Specify port numbers for the Administration Console and HTTP transmissions. The default value for Admin Port is 4848 and for HTTP Port is 8080.

   • To allow access to the Administration Console without a password, leave Username as admin and the Password field empty.

   • To require a password for access to the Administration Console, specify a user name and password in the corresponding fields. User name and password are case sensitive.

7. Specify whether to install Update Tool.

   Update Tool is an administrative tool that enables you to install updates and add-on components to an existing GlassFish Server 3.0.1 installation. Update Tool can be installed during GlassFish Server installation or at a later time. For more information about Update Tool, see Update Tool in Oracle GlassFish Server 3.0.1 Administration Guide.

   • If you are not installing Update Tool, deselect the Install Update Tool check box.

   • If you are installing Update Tool and your system accesses the Internet through a proxy, specify the proxy host and proxy port.

   • If you are installing Update Tool and do not require the automatic notifications of available updates after installation, deselect the Enable Update Tool check box.

   ---

   Note –

   Update Tool differs from Upgrade Tool, which is used to migrate the configuration and deployed applications from an earlier version of GlassFish Server to the current version. For more information about Upgrade Tool, see the Oracle GlassFish Server 3.0.1 Upgrade Guide.

   ---

8. Specify the path to the JDK to be used with the installation.

   Use a JDK installation detected by the installer or specify the path for a different JDK.

   JDK 6 is required. See Installation Requirements for more information.

   ---

   Note –

   This JDK page is not presented for Mac OS X installations. The installation uses the value in the JAVA_HOME environment variable.

   ---

9. Review the Ready To Install selections and click Install to proceed with the installation.

10. Determine whether and how to register GlassFish Server.

    ---

    Note –

    It is recommended that you select the Skip Registration option during installation.

    Also, installing with Open JDK prevents registration during installation on some Linux platforms. For those environments, use the Administration Console to register GlassFish Server following installation.

    ---

    • If you want to register GlassFish Server but do not yet have a Sun Online Account, select I Don't Have a Sun Online Account, click Next, and provide the requested information.

    • If you want to register GlassFish Server and already have a Sun Online Account, select I Already Have a Sun Online Account and provide your user name and password. Your user name is the email address that you specified when you created the account.

    • If you do not want to register GlassFish Server at the time of installation, select Skip Registration and click Next. You can register later through the GlassFish Server Administration Console.

11. Review the summary page that displays after registration and click Exit to exit the installer.

    Installation information is captured in log files. The names of the files are timestamp-install.log and timestamp-install-summary.html. On Solaris, Linux, and Mac OS X systems, these files are generated under the $TMP directory. On Windows systems, these files are generated under the %TEMP% directory.

12. (Optional) Start GlassFish Server using the instructions in the Oracle GlassFish Server 3.0.1 Quick Start Guide.

    The guide explains how to perform basic tasks such as starting the server, accessing the Administration Console, and deploying a sample application.

Using GlassFish Server Silent Mode Installation

This section describes how to install GlassFish Server 3.0.1 using silent mode installation. Silent mode is a non-interactive installation based on user-defined parameters captured in an answer file. The answer file can be used later to install GlassFish Server on one or more systems. The following topics are addressed in this section:

• Creating the Installation Answer File

• Reviewing the Installation Answer File

• Installing in Silent Mode

Creating the Installation Answer File

The answer file forms the template for silent installation. The file is created when you use the trial mode (-n) option to start an interactive installation. In trial mode, actual installation does not take place.

During the interactive installation you can accept the default values presented or you can change them. Your input is collected and stored in the answer file, which is then used to install GlassFish Server. You can use the answer file as it is or you can modify the file before using it.

To Create the Installation Answer File

The installation wizard is used to create the answer file. Actual installation does not take place.

Before You Begin

Ensure that your system meets the requirements listed in Hardware and Software Requirements in Oracle GlassFish Server 3.0.1 Release Notes.

Also see Known Issues in Oracle GlassFish Server 3.0.1 Release Notes for known issues related to installation.

1. Download the desired GlassFish Server 3.0.1 bundle.

   See GlassFish Server Download Locations for a list of download locations. See Table 1–3 for a list of available self-extracting bundles.

2. Start the installation in trial mode.

   1. Change to the directory where you downloaded the self–extracting file.

   2. On Solaris, Linux, and Mac OS X systems, grant execute permissions to the self–extracting file if necessary:

      chmod +x ./self-extracting-file-name

   3. From the command line, type:

      self-extracting-file-name -n answer-file

      self-extracting-file-name is the name of the self-extracting file that you downloaded.

      -n specifies trial mode installation.

      answer-file is the name you assign to the answer file. If you do not include a path to the file, the file is created under the directory from which the installation program is run.

      For example:

      ogs-3.0.1-unix.sh -n 3.0.1-answer

   The Welcome page is displayed. Use the Next button to move through the installation process.

3. Respond to the license agreement.

4. Specify where to install GlassFish Server.

   The default installation directory is as follows:

   • Solaris, Linux, and Mac OS X systems: user's-home-directory/glassfishv3

   • Windows systems: SystemDrive:\glassfishv3

   The default installation directory is referred to as as-install-parent throughout GlassFish Server documentation.

5. Specify administration settings.

   • Specify port numbers for the Administration Console and HTTP transmissions. The default value for Admin Port is 4848 and for HTTP Port is 8080.

   • To allow access to the Administration Console without a password, leave Username as admin and the Password field empty.

   • To require a password for access to the Administration Console, specify a user name and password in the corresponding fields. User name and password are case sensitive.

6. Specify whether to install Update Tool.

   Update Tool is an administrative tool that enables you to install updates and add-on components to an existing GlassFish Server 3.0.1 installation. Update Tool can be installed during GlassFish Server installation or at a later time. For more information about Update Tool, see Update Tool in Oracle GlassFish Server 3.0.1 Administration Guide.

   • If you are not installing Update Tool, deselect the Install Update Tool check box.

   • If you are installing Update Tool and your system accesses the Internet through a proxy, specify the proxy host and proxy port.

   • If you are installing Update Tool and do not require the automatic notifications of available updates after installation, deselect the Enable Update Tool check box.

   ---

   Note –

   Update Tool differs from Upgrade Tool, which is used to migrate the configuration and deployed applications from an earlier version of GlassFish Server to the current version. For more information about Upgrade Tool, see the Oracle GlassFish Server 3.0.1 Upgrade Guide.

   ---

7. Specify the path to the JDK to be used with the installation.

   Use a JDK installation detected by the installer, or specify the path for a different JDK.

   JDK 6 is required. See Installation Requirements for more information.

   ---

   Note –

   This JDK page is not presented for Mac OS X installations. The installation uses the value in the JAVA_HOME environment variable.

   ---

8. Review the Ready to Install selections and click Install to proceed with trial mode installation and create the answer file.

   Unless a path to the file was specified in Step 2, the answer file is created under the directory from which the installation program is run.

Reviewing the Installation Answer File

The answer file provides a number of system-specific parameters as well as parameters that you selected during trial mode installation. Values for some parameters can be edited as described in To Edit the Answer File.

The following example shows the contents of an answer file that was created during a trial mode installation. Default values were accepted during the installation.

Example 1–1 Example Answer File

#openInstaller Dry Run Answer File. This File can be used as input to
the openInstaller engine using the -a option.
#Tue Nov 10 19:25:05 PST 2009
RegistrationOptions.regoptions.CREATE_NEWACCT=CREATE_NEWACCT
glassfish.Administration.HTTP_PORT=8080
updatetool.Configuration.PROXY_PORT=
glassfish.Administration.ADMIN_PASSWORD=
JDKSelection.directory.JDK_FROM_LIST_CHOICE=true
RegistrationOptions.regoptions.SKIP_REGISTRATION=SKIP_REGISTRATION
updatetool.Configuration.PROXY_HOST=
SOAccountCreation.accountinfo.COUNTRY=
InstallHome.directory.INSTALL_HOME=C\:\\glassfishv3
RegistrationOptions.regoptions.USE_EXISTINGACCT=USE_EXISTINGACCT
SOAccountCreation.accountinfo.FIRSTNAME=
updatetool.Configuration.ALLOW_UPDATE_CHECK=true
glassfish.Administration.ADMIN_USER=admin
JDKSelection.directory.JDK_LIST=JDK-location
SOAccountCreation.accountinfo.PASSWORD=
SOAccountCreation.accountinfo.COMPANYNAME=
JDKSelection.directory.HIDDEN_JDK=JDK-location
SOAccountCreation.accountinfo.COUNTRY_DROP_DOWN=
SOAccountCreation.accountinfo.REENTERPASSWORD=
License.license.ACCEPT_LICENSE=0
RegistrationOptions.regoptions.USERNAME=
updatetool.Configuration.BOOTSTRAP_UPDATETOOL=true
SOAccountCreation.accountinfo.LASTNAME=
glassfish.Administration.ADMIN_PORT=4848
RegistrationOptions.regoptions.USERPASSWORD=
JDKSelection.directory.JDK_TYPED_IN_CHOICE=false
SOAccountCreation.accountinfo.EMAIL=
JDKSelection.directory.JDK_TYPE_IN=
RegistrationOptions.regoptions.DUMMY_PROP=

To Edit the Answer File

Some values in the answer file can be changed if desired. Such editing is strictly optional.

Before You Begin

Create the answer file as described in To Create the Installation Answer File.

1. Review the answer file.

   Review the values that will be used for silent installation.

2. Edit the answer file.

   Only the following default values can be changed:

   InstallHome.directory.INSTALL_HOME=as-install-parent

   Provide another directory name for GlassFish Server 3.0.1 installation files.

   glassfish.Administration.ADMIN_PASSWORD=

   Provide a password for access to the Administration Console. This password is case sensitive.

   glassfish.Administration.ADMIN_PORT=4848

   Assign another port number to the Administration Console.

   glassfish.Administration.ADMIN_USER=admin

   Provide another user name for the administrator. This name is case sensitive.

   glassfish.Administration.HTTP_Port=8080

   Assign another port number to HTTP connections.

   glassfish.Administration.JDK_TYPE_IN=jdk-location

   Can be set to a location that contains a required JDK 6 installation.

   glassfish.Administration.JDK_TYPED_IN_CHOICE=true

   Can be set to true or false. Always set this value to true if you are using the answer file for silent installation.

   glassfish.Administration.HIDDEN_JDK=jdk-location

   Not to be used for this release. Ignore this variable.

   updatetool.Configuration.ALLOW_UPDATE_CHECK=true

   Change value to false if you do not want Update Tool notifications.

   updatetool.Configuration.BOOTSTRAP_UPDATE=true

   Change value to false if you do not want to install the standalone Update Tool.

   updatetool.Configuration.PROXY_HOST=

   Assign a name to the proxy host.

   updatetool.Configuration.PROXY_PORT=

   Assign a port number to the proxy host.

   ---

   Note –

   Parameters not listed are system specific. Do not change system-specific parameters. Doing so will cause problems with the installation program.

   ---

Installing in Silent Mode

The non-interactive installation program reads the specified answer file, checks for adequate disk space, and installs GlassFish Server based on the data in the answer file.

To Install Using Silent Mode

Before You Begin

Create the answer file as described in To Create the Installation Answer File.

Verify that the parameters in the answer file are set to the values that you want to use for silent installation.

1. Navigate to the directory that contains the self-extracting installer file and the installation answer file.

2. From the command line, type:

   self-extracting-file-name -a answer-file -s

   self-extracting-file-name is the name of the file that you downloaded during Creating the Installation Answer File. Ensure that you provide the complete path to the answer file.

   -a specifies the name of the answer-file. If you do not include a path to the file, the file is created under the directory from which the installation program is run.

   -s specifies running in silent mode.

   For example:

   ogs-3.0.1-unix.sh -a 3.0.1-answer -s

   When the prompt is returned, the silent installation is complete and the installation components are installed on your system.

3. (Optional) Start GlassFish Server using the instructions in the Oracle GlassFish Server 3.0.1 Quick Start Guide.

   The guide explains how to perform basic tasks such as starting the server, accessing the Administration Console, and deploying a sample application.

Installation Command-Line Options

The following options can be used when you run the installation program from the command line using the self-extracting installation file (.sh or .exe). Specify the desired options after typing the installation file name at the command prompt.

For example:

ogs-3.0.1-unix.sh -a 3.0.1-answer -l log-directory -s

The options are as follows:

-a answer-file

Run the installation program in silent mode using the answer file specified. Use this option with the -s option.

-l log-directory

Write log information to this directory.

-q

Set logging level to WARNING.

-v

Set logging level to FINEST.

-s

Run the installation program in silent mode.

-j javahome

Use this directory for the JDK software installation.

-n answer-file

Run the installation program in trial mode to generate the answer file for silent mode installation.

-h or -help

Display the help message listing these options.