JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle GlassFish Server 3.1 Installation Guide
search filter icon
search icon

Document Information

Preface

1.  Installing GlassFish Server 3.1

Installation Requirements

Javassist Library License Notice

Installation Files for GlassFish Server 3.1

GlassFish Server Download Locations

GlassFish Server Installation Methods

Choosing an Installation Method

ZIP Package or Self-Extracting Bundle?

Full Platform or Web Profile Distribution?

GlassFish Server ZIP Files

GlassFish Server Self-Extracting Bundles

HTTP Load Balancer Plug-in for Oracle GlassFish Server

Installing GlassFish Server From a ZIP File

To Install GlassFish Server Using the ZIP File

Installing GlassFish Server From a Self-Extracting Bundle

To Install GlassFish Server Using the Self-Extracting File

To Perform a Custom Installation

Custom Configuration Parameters

Parameters for the Create a server domain Option

Parameters for the Create a standalone server instance Option

Parameters for the Create a clustered server instance Option

Performing a Silent Mode Installation

Creating the Installation Answer File

To Create the Installation Answer File

Reviewing the Installation Answer File

To Edit the Answer File

Installing in Silent Mode

To Install Using Silent Mode

Installation Command-Line Options

2.  Uninstalling GlassFish Server 3.1

Index

Installing GlassFish Server From a Self-Extracting Bundle

This section describes how to install Oracle GlassFish Server 3.1 software using one of the self-extracting installation bundles. Running any of the self-extracting bundles automatically launches the GUI-based GlassFish Server installation wizard.

The following topics are addressed here:


Note - Console installation is not supported in Oracle GlassFish Server 3.1. Silent mode installation is available, however. For more information, see Performing a Silent Mode Installation.


To Install GlassFish Server Using the Self-Extracting File

Before You Begin

  1. Download the desired GlassFish Server 3.1 bundle.

    See GlassFish Server Download Locations for a list of download locations. See Table 1-4 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:
        sh ./self-extracting-file-name

        For example, start the installer by typing the following:

        sh ./ogs-3.1-unix.sh

        See Installation Command-Line Options for a list of command-line options you can specify here, if desired.

    • Windows systems:
      1. Double-click the executable .exe installation file.

        For example, double-click:

        ogs-3.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.

    • Depending on your user privileges and the version of Windows you are running, it may be necessary to run the installer as Administrator. In particular, if you will be configuring the domain as a Service as part of a Custom Installation (see next step) or after the installation, then you should run the installer as Administrator.


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

  4. Choose the Installation Type
    • Typical Installation

      Choose this option for application development purposes or non-production use only. This option installs the GlassFish Server binaries and creates a DAS.

    • Custom Installation

      Choose the option if you are deploying GlassFish Server in a production environment. This option provides several installation choices, which are described in detail later in this guide, in To Perform a Custom Installation.

    The remainder of this procedure describes the steps in the Typical Installation path. If you are performing a Custom Installation, skip the remainder of this procedure and jump instead to To Perform a Custom Installation.

  5. Specify where to install GlassFish Server.

    The default installation directories are as follows:

    • Solaris, Linux, and Mac OS X systems
      user-home-directory/glassfish3
    • Windows systems
      SystemDrive\glassfish3

    Make sure the directory you specify is empty before installing the product.

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

  6. Specify whether to install and enable Update Tool.

    Update Tool is an administrative tool that enables you to install updates and add-on components to an existing GlassFish Server 3.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.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.1 Upgrade Guide.


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

    A progress bar is displayed as the core GlassFish Server components are installed and the default domain is automatically created and started.

    The installer creates a default domain named domain1. The results of this process will be briefly visible in the ConfigResults screen.


    Tip - The configuration results panel presents the recently executed command in the center section and this is a selectable text. The text can be copied on to a script for future automated runs of such commands.



    Note - If you choose to cancel the installation at this point, no GlassFish Server files will be installed, but the directory you specified for as-install-parent will remain. This directory can be deleted manually.


  8. Review the summary page 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 by default in the /tmp directory. On Windows systems, these files are generated in the %TEMP% directory.

  9. (Optional) Register your GlassFish Server product.

    Follow the instructions on the registration screen to complete the registration process.

See Also

Familiarize yourself with the instructions in the Oracle GlassFish Server 3.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.

To Perform a Custom Installation

This procedure builds upon the instructions provided for the Typical Installation path in To Install GlassFish Server Using the Self-Extracting File.

  1. Complete the steps in To Install GlassFish Server Using the Self-Extracting File.
  2. Choose the kind of Custom Installation you want to perform.
    • Install and Configure

      Install the GlassFish Server binaries, and then configure a DAS and one or more standalone server instances, clusters, or clustered instances.

    • Install Only

      Install only the GlassFish Server binaries, without configuring a DAS or any server instances or clusters. You can rerun the GlassFish Server installation wizard at a later time and choose the Configure an Existing Installation option to configure the items.

    • Configure an Existing Installation

      Configure a DAS, standalone server instances, clusters, or clustered instances for an existing GlassFish Server 3.1 installation. Note that this option is not for upgrading from an older version of GlassFish Server. For instructions on upgrading from a version of GlassFish Server prior to 3.1, see the Oracle GlassFish Server 3.1 Upgrade Guide.

    The remainder of this procedure explains the Install and Configure option. Most of these steps also apply to the other options.

  3. Specify where to install GlassFish Server.

    The default installation directories are as follows:

    • Solaris, Linux, and Mac OS X systems
      user-home-directory/glassfish3
    • Windows systems
      SystemDrive\glassfish3

    Make sure the directory you specify is empty before installing the product.

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

  4. 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.


  5. 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.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.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.1 Upgrade Guide.


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

    A progress bar is displayed as the core GlassFish Server components are installed and the default domain is automatically created and started.


    Note - If you choose to cancel the installation at this point, no GlassFish Server files will be installed, but the directory you specified for as-install-parent will remain. This directory can be deleted manually.


    When the core installation has completed, the installer displays the Configuration page.

  7. Configure GlassFish Server components.

    The general procedure for configuring server components involves the following substeps:

    1. Choose a component configuration option:
      Create a server domain

      Create a Domain Administration Server (DAS). At least one DAS must be created and running before you can configure any other components. The parameters in the Configuration screen for this option are described in Parameters for the Create a server domain Option.

      Create a standalone server instance

      Create a standalone GlassFish Server instance. The parameters in the Configuration screen for this option are described in Parameters for the Create a standalone server instance Option.

      Create a clustered server instance

      Create a new cluster or a clustered server instance in a new or existing a cluster. The parameters in the Configuration screen for this option are described in Parameters for the Create a clustered server instance Option.

      Skip configuration

      Skip any additional component configuration and proceed immediately to the final steps of the installation and configuration wizard.

      When configuring a new or previously unconfigured GlassFish Server installation you must choose the first option, Create a server domain, before proceeding with any of the other options. Once at least one server domain has been created, you can choose any of the other options in any order you wish, including creating additional domains.

    2. Configure the selected component.

      Each configuration option displays its own configuration screen. The specific options in each configuration screen are described after this procedure, in Custom Configuration Parameters.

    3. Choose how you want to proceed.

      After configuring any one of the available options, a Configuration Results screen is displayed. In addition to displaying the configuration results, three buttons are displayed:

      Cancel

      Cancel the configuration and exit the installation wizard. Note that the core GlassFish Server components will already be installed at this point, as well as any configurations that may have been configured during this step or during another installation. To remove the core GlassFish Server components and any configurations, follow the instructions in Chapter 2, Uninstalling GlassFish Server 3.1

      Configure again

      Return to the Configuration page so you can configure another item.

      Next

      Complete the configuration option and continue to the final steps of the installation and configuration wizard. Note that this label becomes "Exit" if this is a Custom Installation and the “Configure Existing Installation” option is selected.


      Tip - The configuration results panel presents the recently executed command in the center section. This is selectable text, and it can be copied to a script for future automated runs of such commands.


    When you have configured all the components you want and then clicked the Next button, the final configuration option is performed and a Summary screen is displayed.

  8. Click Exit to exit the installation and configuration wizard.

    A web browser is displayed so you can register your GlassFish Server product.

  9. (Optional) Register your GlassFish Server product.

    Follow the instructions on the registration screen to complete the registration process.

See Also

If you are done with the installation at this point, it is recommended that you familiarize yourself with the instructions in the Oracle GlassFish Server 3.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.

Custom Configuration Parameters

This section lists the configuration parameters in the screens displayed for the options in the Configure GlassFish Server components. step in To Perform a Custom Installation.

Parameters for the Create a server domain Option

The following are the parameters displayed in the Configuration screen when you choose the Create a server domain option in Configure GlassFish Server components. step in To Perform a Custom Installation. This option enables you to create a Domain Administration Server (DAS)

Domain Name

The unique domain name to use for the DAS. The default name is domain1.

Admin Port

The port on which the GlassFish Server Admin Console will listen. The default port is 4848.

HTTP Port

The port on which the non-secure HTTP server will listen. The default port is 8080. Note that the port used for the secure HTTP listener is 8181.

Username

The user name for administrative access to the GlassFish Server Admin Console.

Password

The password for administrative access to the GlassFish Server Admin Console. You can leave this parameter empty to enable unauthenticated logins to the Admin Console, but make sure that the Username field has "admin" as the input value. Specifying a password is highly recommended if you are installing GlassFish Server in a production environment.

Reenter Password

Reenter the password to verify your typing.

Create Operating System Service for the domain

Specify whether an operating system service will be created for the DAS. The service will be started when the operating system is booted.

If a service is not created here, the DAS can be started manually using the asadmin start-domain subcommand.


Note - The Create Operating System Service option is not available on Mac OS X systems. Also note that on Unix or Linux systems, you must run the installer as superuser or root if you want to create a system service for the domain.


Service Name

Specify the name for the DAS operating system service. The default name is domain1Service. This parameter is only required if the Create Operating System service parameter is enabled.

Start domain after creation

Start the domain as soon as it is created. This option is enabled by default. Note that is necessary for the DAS to be running before you can configure any server instances or clusters. If you choose to not start the domain at this time, you can start it manually later using the asadmin start-domain subcommand.


Note - Ensure that this option is enabled if you plan on performing more configurations during this installation procedure. The DAS must be running in order to create any server instances or clusters.


Parameters for the Create a standalone server instance Option

The following are the parameters displayed in the Configuration screen when you choose the Create a standalone server instance option in Configure GlassFish Server components. step in To Perform a Custom Installation. This option enables you to create a standalone GlassFish Server instance.


Note - The DAS for the domain in which the standalone server instance will be created must be running with the specified name and at the specified port before configuring a standalone server instance. See the Parameters for the Create a server domain Option for instructions.


Instance Name

The unique name to use for the standalone GlassFish Server instance. If the name is already in use, an error will be generated when the configuration is performed. The default name is instance1.

Host Name

The name of the physical host on which the DAS is running. The default name is localhost.

Administration Port

The administration port on which the DAS is running. The default port is 4848.

Parameters for the Create a clustered server instance Option

The following are the parameters displayed in the Configuration screen when you choose the Create a clustered server instance option in Configure GlassFish Server components. step in To Perform a Custom Installation. This option enables you to create a new cluster or a clustered server instance in a new or existing a cluster.


Note - The DAS for the domain in which the standalone server instance will be created must be running with the specified name and at the specified port before configuring a cluster or clustered server instance. See the Parameters for the Create a server domain Option for instructions.


Instance Name

The unique name to use for the clustered GlassFish Server instance. If the name is already in use, an error will be generated when the configuration is performed. The default name is instance1.

Host Name

The name of the physical host on which the DAS is running. The default name is localhost.

Administration Port

The administration port on which the DAS is running. The default port is 4848.

Create Cluster

Specify whether a new cluster will be created at this time. The default is to leave this option disabled. If left disabled, the cluster specified in the Cluster Name field, below, must already exist.

  • Ensure that this option is enabled if the cluster in which you want to create the clustered server instance does not yet exist.

  • Ensure that this option is disabled if the cluster in which you want to create the clustered server existence already exists.

Cluster Name

The unique name to use for the cluster. If the name is already in use, an error will be generated when the configuration is performed. The default name is c1.

Domain Name

The name of the DAS in which the cluster will run. The default name is domain1.