<?xml version="1.0" encoding="UTF-8"?>
<!-- 
/*
 * Copyright 2001-2004 The Apache Software Foundation.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 -->


<document>
  <properties>
    <title>Maven Webserver Plugin Properties</title>
    <author email="dion@apache.org">dIon Gillard</author>
  </properties>
  <body>
    <section name="Maven Webserver Plugin Settings">
      <table>
        <tr>
          <th>Property</th>
          <th>Optional?</th>
          <th>Description</th>
        </tr>

        <tr>
          <td>maven.webserver.name</td>
          <td>No</td>
          <td>
            <p>The value must be set to one of the supported webserver name
               values. An error is given if the name is not supported.</p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.version</td>
          <td>No</td>
          <td>
            <p>The value must be set to one of the supported webserver version
               values for the specified webserver name. An error is given if the
               name is not supported.</p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.home</td>
          <td>No</td>
          <td>
            <p>The absolute directory path to the home directory installation
               for the webserver name being used.</p>
          </td>
        </tr>

        <!-- ports -->
        <tr>
          <td>maven.webserver.port.http</td>
          <td>Yes if maven.webserver.port.https has a value, otherwise no.</td>
          <td>
            <p>Default value is <code>80</code></p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.port.https</td>
          <td>Yes if maven.webserver.port.http has a value, otherwise no.</td>
          <td>
            <p>Default value is <code>443</code></p>
          </td>
        </tr>

        <tr>
          <td>maven.webserver.port.A</td>
          <td>Yes</td>
          <td>
            <p>Default value is <code><i>null</i></code></p>
            <p>Optional port that can be used for configuration, added by
            default to the filterset used when copying configuration files.
            </p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.port.B</td>
          <td>Yes</td>
          <td>
            <p>Default value is <code><i>null</i></code></p>
            <p>Optional port that can be used for configuration, added by
            default to the filterset used when copying configuration files.
            </p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.port.C</td>
          <td>Yes</td>
          <td>
            <p>Default value is <code><i>null</i></code></p>
            <p>Optional port that can be used for configuration, added by
            default to the filterset used when copying configuration files.
            </p>
          </td>
        </tr>

        <!-- install related -->
        <tr>
          <td>maven.webserver.dir</td>
          <td>No</td>
          <td>
            <p>Default value is
              <code>${basedir}/server</code></p>
            <p>This is the directory where the server instance willl be installed
            to and run from.
            </p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.fullname</td>
          <td>No</td>
          <td>
            <p>Default value is
            <code>${maven.webserver.name}-${maven.webserver.version}</code></p>
            <p>Modifying this property will likely prevent the plugin from
            working properly. It is highly recommended to not change the default
            value.</p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.conf.dir</td>
          <td>No</td>
          <td>
            <p>Default value is
              <code>${maven.conf.dir}/webserver/${maven.webserver.fullname}</code></p>
            <p>This property's value is set by default for consistency. It is
            not recommended the value be changed, although it can be. Instead
            if you have server specific configuration files, put them in a
            directory structure under your configuration dir as above.</p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.root</td>
          <td>No</td>
          <td>
            <p>Default value is
              <code>${maven.webserver.dir}/webapps/ROOT</code></p>
            <p>This should be absolute path to the root directory where you
            would like your server instance to serve files from.</p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.user</td>
          <td>Yes</td>
          <td>
            <p>Default value is <code>apache</code>.</p>
            <p>This is the user that Apache should run as.</p>
          </td>
        </tr>
        <tr>
          <td>maven.webserver.group</td>
          <td>Yes</td>
          <td>
            <p>Default value is <code>apache</code>.</p>
            <p>This is the group that Apache should run as.</p>
          </td>
        </tr>


        <!-- test related -->
        <tr>
          <td>maven.webserver.test.socket</td>
          <td>No</td>
          <td>
            <p>Default value is <code>${maven.webserver.port.http}</code>OR
            if not set then <code>${maven.webserver.port.https}</code></p>

          </td>
        </tr>

        <tr>
          <td>maven.webserver.test.url</td>
          <td>Yes</td>
          <td>
            <p>Default value is <code>null</code>. If specified, the plugin uses
            a valid response from the URL in addition to
            ${the maven.webserver.test.socket} to determine if the webserver is
            running.</p>
          </td>
        </tr>

        <tr>
          <td>maven.webserver.host</td>
          <td>Yes</td>
          <td>
            <p>Default value is <code>localhost</code>. This needs to be set the
            name of the server running the server instance.</p>
          </td>
        </tr>

      </table>
    </section>
  </body>
</document>
