9d52f1b92a
MPSITE-39 : Deploy site on unix create rights rwxr-xr-x. Group members can't override files. The default value for maven.site.chmod.mode is now 755. Split remote tasks to be sure to execute all of them if maven.site.failonerror=false git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@327739 13f79535-47bb-0310-9956-ffa450edef68
202 lines
7.1 KiB
XML
202 lines
7.1 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!--
|
|
/*
|
|
* 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>Site Properties</title>
|
|
<author email="smor@apache.org">Stéphane MOR</author>
|
|
<author email="alef@jteam.nl">Alef Arendsen</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Site Properties">
|
|
<table>
|
|
<tr>
|
|
<td>maven.site.stage.address</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the site address to use when publishing to staging. If not specified, the same address
|
|
is used as live.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.stage.directory</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the site directory to use when publishing to staging. If not specified, the same directory
|
|
is used as live.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.deploy.live</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Force the use of the live deployment parameters, even if the staging ones are specified
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.deploy.clean</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
This will ensure the target in a <code>site:deploy</code> goal is
|
|
clean by either deleting the directory first, or rsync'ing with the <code>--delete</code> option.
|
|
This operation is not atomic, so is not recommended for the live site unless you are using the rsync method.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.publish.clean</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
This will ensure the target in a <code>site:publish</code> goal is
|
|
clean by either deleting the directory first, or rsync'ing with the <code>--delete</code> option.
|
|
This operation is not atomic, so is not recommended for the live site unless you are using the rsync method.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.scp.executable</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the name (and possibly location) of the remote secure
|
|
copy executable to use (SCP). This is used by the
|
|
"site:deploy" goal.
|
|
The default value is <code>scp</code> (i.e. an executable
|
|
named <code>scp</code> must be in your path).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.scp.args</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies optional parameters that are passed to the scp executable.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ssh.executable</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the name (and possibly location) of the remote secure
|
|
shell executable to use (SSH). This is used by the "site:deploy" goal.
|
|
The default value is <code>ssh</code> (i.e. an executable
|
|
named <code>ssh</code> must be in your path).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.rsync.executable</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the name (and possibly location) of the remote rsync
|
|
executable to use. This is used by the "site:publish" and
|
|
"site:rsyncdeploy" goal.
|
|
The default value is <code>rsync</code> (i.e. an executable
|
|
named <code>rsync</code> must be in your path).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.rsync.args</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies optional parameters that are passed to the rsync executable (in addition to -az).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ssh.args</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies optional parameters that are passed to the ssh executable.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.chmod.options</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies options passed to the chmod executable. Default is '<code>-Rf</code>'.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.chmod.mode</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the mode set by the chmod executable. Default is '<code>g+u</code>'.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.deploy.method</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the method to use when deploying the site. Possible values are: <code>ftp</code>, <code>rsync</code>,
|
|
<code>fs</code> and <code>ssh</code>. The ssh method is the good old
|
|
method which has always been used within Maven. When you specify
|
|
<code>fs</code> the site will be deployed on a local file system.
|
|
The <code>siteDirectory</code> property will be used to copy the site to.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.tar.executable</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the executable to use for 'tar' when deploying the site.
|
|
Defaults to <code>tar</code>. Override this property if your
|
|
system has a default version of tar that is failing.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.tar.options</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the options to use for 'tar' when deploying the site.
|
|
Defaults to <code>xUvf</code>. Override this property if your
|
|
system has a version of tar that is failing, e.g. it doesn't support the
|
|
<code>U</code> option.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.gunzip.executable</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the executable to use for 'gunzip' when deploying the site.
|
|
Defaults to <code>gunzip</code>. Override this property if your
|
|
system has a default version of gunzip that is failing.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.gunzip.options</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies options passed to the gunzip executable. Default is '<code>-f</code>'.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.site.failonerror</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies if remote commands errors must stop the build.
|
|
Defaults to <code>true</code>.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Using Putty as ssh client">
|
|
<p>Set the following porperties (preferably in your %HOME%/build.properties)</p>
|
|
<source>maven.scp.executable=pscp
|
|
maven.ssh.executable=plink</source>
|
|
</section>
|
|
</body>
|
|
</document>
|