maven-plugins/artifact/xdocs/properties.xml
2004-09-29 10:56:04 +00:00

254 lines
8.2 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>Properties</title>
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
</properties>
<body>
<section name="Maven Artifact Plugin Settings">
<table>
<tr>
<th>Property name</th>
<th>Description</th>
<th>Optional?</th>
</tr>
<tr>
<td>maven.repo.list</td>
<td>
The list of comma separated names of
the repositories to which artifacts produced by
the project will be deployed. E.g.:
<br/>
<i>maven.repo.list=myrepo1,ibiblio</i>
<br/>
The names of all other properties are constructed using the
entries present in this list.
Below the set of properties which can be used for
configuration of deployment process to each of the repositories
provided in the list. <i>x</i> in the names
of those properties should be replaced by actual repository name
(like <i>ibiblio</i>).
In case of doubts see an <a href="examples.html">example</a>
</td>
<td>No</td>
</tr>
<tr>
<td>maven.repo.x</td>
<td>
Specifies the URL of remote repository. The URL
should contain the protocol name.
<br/>
See the <a href="protocols.html">the list</a> of supported protocols.
<br/>
x corresponds to
repository name defined using <i>maven.repo.list</i> property.
</td>
<td>No</td>
</tr>
<tr>
<td>maven.repo.x.directory</td>
<td>
The path on the remote file system where artifacts will be placed
</td>
<td>No</td>
</tr>
<tr>
<td>maven.repo.x.username</td>
<td>
The user name that will be used to authenticated
user if access to repository requires authentication.
</td>
<td>Yes</td>
</tr>
<tr>
<td>maven.repo.x.password</td>
<td>
The password which will be used to authenticate
user.
<br/>
If server/protocol supports authentication via
both private/public keys and password,
it will first try to use keys for authentication
and if that doesn't work then
will fall back to using the username and password
</td>
<td>Yes</td>
</tr>
<tr>
<td>maven.repo.x.group</td>
<td>
The remote group (UNIX group) to which
the artifact will belong after it
is deployed
</td>
<td>Yes</td>
</tr>
<tr>
<td>maven.repo.x.mode</td>
<td>
The remote file mode (UNIX permissions) to which
the artifact will be set to after it
is deployed. Default is <code>g+w</code>.
</td>
<td>Yes</td>
</tr>
<tr>
<td>maven.repo.x.directory.mode</td>
<td>
The remote directory mode (UNIX permissions)
when directories are created while deploying the artifact.
Default is <code>maven.repo.x.mode</code>.
<b>Warning:</b> if you are using an octal file permission,
you should not use the default value for this as you should
add the executable permission for directories.
</td>
<td>Yes</td>
</tr>
<tr>
<td>maven.repo.x.privatekey</td>
<td>
The absolute path to private key file.
<br/>
Thie is used only for when protocol
supports authentication via private/public
key pair.
</td>
<td>Yes</td>
</tr>
<tr>
<td>maven.repo.x.passphrase</td>
<td>
The passphrase used to decrypt private key file
</td>
<td>Yes</td>
</tr>
<tr>
<td>maven.repo.x.compress</td>
<td>
Used by scp if you want to compress the stream.
</td>
<td>Yes</td>
</tr>
</table>
</section>
<section name="Protocol-specific Properties">
<subsection name="scpexe">
<table>
<tr>
<td>maven.repo.x.scp.executable</td>
<td>Yes</td>
<td>
Specifies the name (and possibly location) of the remote secure
copy executable to use (SCP).
The default value is <code>maven.scp.executable</code>.
</td>
</tr>
<tr>
<td>maven.repo.x.scp.args</td>
<td>Yes</td>
<td>
Specifies optional parameters that are passed to the scp executable.
</td>
</tr>
<tr>
<td>maven.repo.x.ssh.executable</td>
<td>Yes</td>
<td>
Specifies the name (and possibly location) of the remote secure
shell executable to use (SSH).
The default value is <code>maven.ssh.executable</code>.
</td>
</tr>
<tr>
<td>maven.repo.x.ssh.args</td>
<td>Yes</td>
<td>
Specifies optional parameters that are passed to the ssh executable.
</td>
</tr>
<tr>
<td>maven.repo.x.port</td>
<td></td>
<td>
This property has no effect with scpexe protocol, use args instead.
</td>
</tr>
</table>
</subsection>
</section>
<section name="Other properties used">
<p>
If you are behind firewall and need to use proxy server see
<a href="http://maven.apache.org/reference/user-guide.html#Using Proxies">following</a>
section from the <b>Maven User Guide</b> .
</p>
</section>
<section name="Deploy Properties (DEPRECATED)">
<table>
<tr>
<td>maven.artifact.legacy</td>
<td>Yes</td>
<td>
Force legacy (deploy) operation mode, where the SSH and SCP command line tools are used.
If artifact is not configured, this will take effect automatically.
</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).
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).
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.ssh.args</td>
<td>Yes</td>
<td>
Specifies optional parameters that are passed to the ssh executable.
</td>
</tr>
</table>
</section>
</body>
</document>