| <html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Chapter 9. The Web Admin Console</title><meta content="DocBook XSL Stylesheets V1.76.0" name="generator"><link rel="home" href="index.html" title="Virgo User Guide"><link rel="up" href="index.html" title="Virgo User Guide"><link rel="prev" href="ch08s04.html" title="Using the p2 for extending your Virgo installation"><link rel="next" href="ch09s02.html" title="Typical Admin Console Use Cases"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><td align="left" width="20%"><a accesskey="p" href="ch08s04.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ch09s02.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 9. The Web Admin Console"><div class="titlepage"><div><div><h2 class="title"><a name="admin-console"></a>Chapter 9. The Web Admin Console</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch09.html#admin-console-login">Invoking the Admin Console</a></span></dt><dd><dl><dt><span class="section"><a href="ch09.html#admin-console-auth">Changing the Admin User</a></span></dt></dl></dd><dt><span class="section"><a href="ch09s02.html">Typical Admin Console Use Cases</a></span></dt><dd><dl><dt><span class="section"><a href="ch09s02.html#admin-console-manage-artifacts">Viewing and Managing the Lifecycle of Deployed Artifacts</a></span></dt><dt><span class="section"><a href="ch09s02.html#admin-console-install-artifacts">Installing a New Artifact</a></span></dt><dt><span class="section"><a href="ch09s02.html#admin-console-view-properties">Viewing Properties of Deployed Configuration Artifacts</a></span></dt><dt><span class="section"><a href="ch09s02.html#admin-console-view-dumps">Viewing the Details of Dump Files</a></span></dt><dt><span class="section"><a href="ch09s02.html#admin-console-view-osgi-state">Viewing Overview and Details of the OSGi State</a></span></dt></dl></dd></dl></div><p>The Web Server Admin Console is a Web application for managing a single instance of Virgo Server for Apache Tomcat or Virgo Jetty Server |
| (referred to, generically, as "Web Server" below). Using the Admin Console, you can:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a class="link" href="ch09.html#admin-console-login" title="Invoking the Admin Console">View an overview of the Web Server properties</a>.</p></li><li class="listitem"><p><a class="link" href="ch09s02.html#admin-console-manage-artifacts" title="Viewing and Managing the Lifecycle of Deployed Artifacts">View and manage the lifecycle</a> of artifacts already deployed to the Web Server instance. Artifacts include bundles, configuration files, PARs, and plans. Lifecycle management tasks include starting, stopping, refreshing, and uninstalling the artifacts.</p></li><li class="listitem"><p><a class="link" href="ch09s02.html#admin-console-install-artifacts" title="Installing a New Artifact">Install new artifacts to Web Server</a>.</p></li><li class="listitem"><p><a class="link" href="ch09s02.html#admin-console-view-properties" title="Viewing Properties of Deployed Configuration Artifacts">View the properties of the configuration artifacts</a> deployed to Web Server.</p></li><li class="listitem"><p><a class="link" href="ch09s02.html#admin-console-view-dumps" title="Viewing the Details of Dump Files">View details of dump files</a> that Web Server might have generated after encountering a problem. This feature is particularly valuable if Web Server fails to install a new artifact due to resolution failures; the OSGi state inspector can help you discover the exact artifact causing the resolution failure.</p></li><li class="listitem"><p><a class="link" href="ch09s02.html#admin-console-view-osgi-state" title="Viewing Overview and Details of the OSGi State">View an overview and details of the OSGi State</a> of Web Server, or in other words, a list of all bundles currently installed in Web Server and their state. You can then drill down into the details of each bundle, such as its symbolic name, packages it imports and exports, services it provides and consumes, and so on. You can also view the bundles that were deployed when an exception that generated a dump occurred.</p></li></ul></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3> |
| This section is not applicable to Virgo Nano. |
| </div><div class="section" title="Invoking the Admin Console"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="admin-console-login"></a>Invoking the Admin Console</h2></div></div></div><p> |
| To use the Admin Console, start the |
| Virgo Server for Apache Tomcat and then enter the following URL in your |
| browser of choice. |
| </p><pre class="screen">http://localhost:8080/admin</pre><p> |
| Replace <code class="literal">localhost</code> with the hostname of the computer on which the Virgo Server for Apache Tomcat is running if it is not the same as the computer on which you are running your browser. </p><p>The Admin Console uses basic authentication, therefore you will need to enter the default administration ID and password. |
| </p><pre class="screen">ID: admin |
| Password: springsource</pre><p>The following graphic shows the main page of the Admin Console. |
| </p><div class="mediaobject" align="right"><table cellpadding="0" cellspacing="0" summary="manufactured viewport for HTML img" border="0"><tr><td align="right" valign="bottom"><img src="images/console-main-page.png" align="right"></td></tr></table></div><p> |
| |
| </p><p>Use the links at the top of the console to perform various tasks, such as viewing and managing artifacts (<span class="bold"><strong>Artifacts</strong></span>), viewing the properties of deployed configuration artifacts (<span class="bold"><strong>Configuration</strong></span>), viewing details of dumps (<span class="bold"><strong>Dump Inspector</strong></span>), and viewing the OSGi state of the Web Server instance (<span class="bold"><strong>OSGi State</strong></span>).</p><p>You can always return to the main Admin Console page by clicking <span class="bold"><strong>Information</strong></span> in the top right-hand corner.</p><p>The <code class="literal">Server Properties</code> section provides information about Web Server itself, such as details about the Java Virtual Machine (JVM), the operating system on which Web Server is installed, the time zone configured for the computer, and the complete version of Web Server.</p><div class="section" title="Changing the Admin User"><div class="titlepage"><div><div><h3 class="title"><a name="admin-console-auth"></a>Changing the Admin User</h3></div></div></div><p> |
| To change the ID and password for the Admin Console, update the <code class="literal">SERVER_HOME/configuration/org.eclipse.virgo.kernel.users.properties</code> file. First specify the administration username by changing the value of the <code class="literal">role.admin</code> property. Then set the password of this new user by adding a new property called <code class="literal">user.<span class="emphasis"><em>username</em></span></code>, where <code class="literal"><span class="emphasis"><em>username</em></span></code> refers to the actual name of the user. Finally, restart Web Server for the changes to take effect.</p><p>For example, if you want change the administration username to <code class="literal">juliet</code> with password <code class="literal">capulet</code>, change the file as follows: |
| </p><pre class="programlisting">################## |
| # User definitions |
| ################## |
| user.juliet=capulet |
| |
| |
| ################## |
| # Role definitions |
| ################## |
| role.admin=juliet</pre><p> |
| The Admin Console always runs against the <code class="literal">admin</code> role. |
| </p></div></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ch08s04.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="ch09s02.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%"> </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> </td></tr></table></div></body></html> |
