The Geronimo Administration Console is a Web based interface that provides a convenient, user friendly way to administer many aspects of the Geronimo Server. Once you have the Apache Geronimo server started (see Tools and commands) you can access the Administration Console by pointing your browser to the following URL:

http://localhost:8080/console

The Administration Console log in page is depicted in the following figure.

Log in by specifying system as the username and manager as the password. Once you are logged in you will be redirected to the console's welcome page. The console has two main areas, a navigation panel on the left and a main content area on the right.

The navigation panel on the left provides easy access to the individual tasks, it is always present and allows easy transition from task to task. The main content area on the right is where the real work happens, this area will change as you select the different tasks in the navigation panel on the left. Each view contains one or more portlets that typically include a link for help in the header, see the following figure as an example.

Back to Top

Console Navigation (left panel)

As briefly explained in the previous section, the navigation panel provides access to the different tasks for administering the resources in Geronimo. This navigation panel is organized in the following main groups:

Welcome
Server
Services
Applications
Security
Misc

Welcome

This is the welcome page you see when you log in. It provides a gerenal description of what the Geronimo Administration Console is as well as some shortcut links to common tasks such as:

Common Console Actions

• Database Pools
• Security Realms
• JMS Resources
• Deploy Applications
• Web Server Ports
• Memory & Uptime

This page also provide links to:

Geronimo Online

• The Geronimo Home Page
• Problem Tracking Database
• Users Mailing List
• Developers Mailing List
• Geronimo IRC chat

Geronimo Documentation

• FAQ
• Wiki
• Geronimo Documentation
• Additional Documentation

Back to Top

Server

Organized under the Server group you will find statistical information as well as links for configuring and administering the different servers. This group is organized as follows:

Information
JVM
Server Logs
Shutdown
Web Server
JMS Server

Back to Top

Information

This portlet displays the server's uptime and the resources being used by the JVM.

JVM

This portlet displays the values of the system properties available to the server process.

Server Logs

This option provides four portlets, Log Manager, Server Log Viewer, Derby Log Viewer and Web Access Log Viewer.

• Log Manager
  This portlet allows the user to select a configuration file for logging and/or change the log level and Refresh period. The default "Config file" is a standard log4j file and defines the location where the Geronimo Server will log Geronimo output. The configuration file also defines the log level, the maximum log file size, and other attributes associated with logging.

• Server Log Viewer
  This portlet displays the Geronimo server log and is helpful for debugging problems with the Geronimo Console and with deployed applications.

• Derby Log Viewer
  This portlet displays the log file for Geronimo's internal database, Derby.

• Web Access Log Viewer
  This portlet displays and filters the Web container log file. This log file contains HTTP accesses and messages from JSP and servlet applications that are running on Geronimo. By default this portlet displays the contents of the log file for the current date. You can apply different filtering criteria to view only data of your interest.

Back to Top

Shutdown

This portlet allows a warm reboot of the server or a shutdown of it. A warm reboot will shutdown all applications and services and reboot the Geronimo kernel within the same process. The Administration Console session will be disconnected. Reconnect after the server is back up.

A shutdown will shutdown the server and cause the JVM to exit. To continue using the Geronimo Console after a shutdown, Geronimo must be restarted.

Back to Top

Web Server

This option provides two portlets, Web Server Manager and Network Listeners.

• Web Server Manager
  When this portlet is enabled, it will collect server performance statistics. The values being meassured are:

• • Requests
  • Connections
  • Errors
  • Active Resquests
  • Request Duration
  • Connections Open
  • Connection Requests
  • Connection Duration

    For the last five values, Count, Average and Maximum will be also displayed.

• Network Listeners
  This portlet displays all the connector listeners (HTTP, HTTPS and AJP) and status for both Jetty and Tomcat Web containers. From this portlet you can add new listeners and change the status (stop, start, delete) of the existing connectors.

Back to Top

JMS Server

This option provides two portlets, JMS Server Manager and JMS Network Listeners.

• JMS Server Manager
  This portlet displays the available JMS Brokers and their status. From this portlet you can also start, stop, edit, add and delete JMS Brokers.

• JMS Network Listeners
  This portlet displays all the network connectors configured for the currently available JMS Brokers. From this portlet you can also start, stop, edit, add and delete JMS network connectors.

Back to Top

Services

Organized under this group you will find links for configuring the following services:

Common Libraries
Database Pools
JMS

Common Libraries

This portlet displays the artifacts installed in the server's repository. The layout of the repository is the same as that used by Apache Maven making it possible to easily copy files over. From this portlet you can also install new artifacts.

Back to Top

Database Pools

This portlet displays all the available database pools and their status. Only server-wide database pools can be edited in this portlet, database pools deployed as part of a single application cannot, you will have to change the deployment plan in the application instead.

From this portlet you can edit the available, system-wide, database pools. There is also a usage link with examples of how to use the pool from your application.

This portlet includes a database pool creation wizard for new pools and also lets you import database pools from JBoss 4 and WebLogic 8.1.

Back to Top

JMS

This option provides two portlets, JMS Connection Factories and JMS Destination Manager.

• JMS Connection Factories
  This portlet displays the JMS connectors that are configured on the server. From this portlet you can see the connectors status, display details, test the connection and new JMS Conneciton Factories.

• JMS Destination Manager
  This portlet is used to create and remove queues/topics.

Back to Top

Applications

Organized under this group you will find links for installing and administering applications.

Deploy New
Application EARs
Web App WARs
EJB JARs
J2EE Connectors
App Clients
System Modules

Deploy New

This portlet allows you to deploy new applications on the Geronimo server. Web applications require deployment plans, which are either packaged with the war file or kept in a separate file which is typically called geronimo-web.xml.

Back to Top

Application EARs

This portlet displays the installed Application EARs and their status. From this portlet you can also stop, start and uninstall the available Application EARs.

Back to Top

Web App WARs

This portlet displays the installed Web Applications and their status. From this portlet you can also stop, start and uninstall the available Web Applications.

Back to Top

EJB JARs

This portlet displays the installed EJB JARs and their status. From this portlet you can also stop, start and uninstall the available EJB JARs.

Back to Top

J2EE Connectors

This portlet displays the installed J2EE Connectors and their status. From this portlet you can also stop, start and uninstall the available J2EE Connectors.

Back to Top

App Clients

This portlet displays the installed Application Clients and their status. From this portlet you can also stop, start and uninstall the available Application Clients.

Back to Top

System Modules

This portlet displays the installed System Modules and their status. From this portlet you can also stop, start and uninstall the available System Modules.

Back to Top

Security

Console Realm
Security Realm
Keystore

Console Realm

This option provides two portlets, Console Realm Users and Console Realm Groups.

• Console Realm Users
  This portlet displays all the Console Realm Users and allows you to add, change password and delete them.

• Console Realm Groups
  This portlet displays all the Console Realm Groups and allows you to add, modify and delete them.

Back to Top

Security Realm

This portlet displays all available security realms and their status. Only server-wide security realms can be edited in this portlet, security realms deployed as part of a single application cannot, you will have to change the deployment plan in the application instead.

From this portlet you can edit the available, system-wide, security realms. There is also a usage link with examples of how to use the realm from your application.

This portlet also includes a security realm creation wizard for creating new realms.

Back to Top

Keystore

This portlet displays the certificates installed, lets you import trusted certificates and generate a key pair.

Back to Top

Misc

At this point this group has only one entry and is for administering the embedded database. The breakdown of this group is as follows.

Embedded DB

• DB Info
• DB Manager

DB Info

This portlet displays information about the internal database, such as:

• Database Product name and version.
• Driver and version.
• Connection URL.
• Supported functions and the supported SQL commands.

Back to Top

DB Manager

This option provides two portlets, DB VIewer and Run SQL.

• DB Viewer
  This portlet displays all the available databases and their tables and displays the contents of the tables. To view the tables in a particular database, click on the database link. This will show all the tables in the database. To view the contents of the tables, click on the View Contents link. At the bottom of the DB Viewer portlet there are links to take you back to View Databases or View Tables.

• Run SQL
  This portlet lets you run SQL commands to manipulate the data in the tables, create a new database or delete a database. You can enter the SQL commands in the SQL Command(s) text box, select the database that will be used and then click on Run SQL to excecute the command.

Back to Top