Author: olamy
Date: Fri Sep 28 06:57:17 2012
New Revision: 1391332
URL: http://svn.apache.org/viewvc?rev=1391332&view=rev
Log:
Apache Archiva Versionned docs for 1.4-M3-SNAPSHOT
Modified:
archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/consumers.html
archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/repositories.html
archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/webapp.html
archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/deploy.html
archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/using-repository.html
Modified: archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/consumers.html
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/consumers.html?rev=1391332&r1=1391331&r2=1391332&view=diff
==============================================================================
--- archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/consumers.html
(original)
+++ archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/consumers.html Fri Sep
28 06:57:17 2012
@@ -380,7 +380,7 @@ pageTracker._trackPageview();</script>
<div id="bodyColumn" class="span10" >
- <!-- Licensed to the Apache Software Foundation (ASF) under one
--><!-- or more contributor license agreements. See the NOTICE file --><!--
distributed with this work for additional information --><!-- regarding
copyright ownership. The ASF licenses this file --><!-- to you 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. --><!-- NOTE: For help
with the syntax of this file, see: --><!-- http://maven.apache.org/guides/mi
ni/guide-apt-format.html --><div class="section"><h2>Understanding Consumers
in Apache Archiva<a
name="Understanding_Consumers_in_Apache_Archiva"></a></h2><p>Archiva makes use
of the concept of consumers. Consumers are components which consumes or
processes an artifact. There is on type of consumers in Archiva: repository
content consumers.</p><div class="section"><h3>Repository Content Consumers<a
name="Repository_Content_Consumers"></a></h3><p>The repository content
consumers consume or process artifacts during repository scanning. For every
artifact found in the repository, each consumer processes them. There are 8
available repository content consumers which can be configured in the
Repository Scanning page. These are:</p><ul><li><i>auto-remove</i> - Removes
files in the repository being scanned if the file type matches any of the
configured file types to be removed. </li><li><i>auto-rename</i> -
Automatically renames common artifact mistakes. </li><li><i>create-missing-
checksums</i> - Creates the md5 and sha1 checksum files of the artifact if
there are none available in the repository. </li><li><i>index-content</i> -
Adds the content of the artifact (specifically the pom) to the index, allowing
the artifact to be searched in Archiva.</li><li><i>metadata-updater</i> -
Updates artifact metadata files depending on the content of the repository.
</li><li><i>repository-purge</i> - Removes old snapshots from the repository
either by the number of days old or by the retention
count.</li><li><i>validate-checksums</i> - Validates the checksum files of the
artifact.</li><li><i>create-archiva-metadata</i> - Take an artifact off of disk
and put it into the metadata repository.</li><li><i>duplicate-artifacts</i> -
Search the artifact repository of known SHA1 Checksums for potential duplicate
artifacts.</li></ul><img src="../images/consumers.png" alt="" /></div></div>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one
--><!-- or more contributor license agreements. See the NOTICE file --><!--
distributed with this work for additional information --><!-- regarding
copyright ownership. The ASF licenses this file --><!-- to you 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. --><!-- NOTE: For help
with the syntax of this file, see: --><!-- http://maven.apache.org/guides/mi
ni/guide-apt-format.html --><div class="section"><h2>Understanding Consumers
in Apache Archiva<a
name="Understanding_Consumers_in_Apache_Archiva"></a></h2><p>Archiva makes use
of the concept of consumers. Consumers are components which consumes or
processes an artifact. There is on type of consumers in Archiva: repository
content consumers.</p><div class="section"><h3>Repository Content Consumers<a
name="Repository_Content_Consumers"></a></h3><p>The repository content
consumers consume or process artifacts during repository scanning. For every
artifact found in the repository, each consumer processes them. There are 8
available repository content consumers which can be configured in the
Repository Scanning page. These are:</p><ul><li><b>auto-remove</b> - Removes
files in the repository being scanned if the file type matches any of the
configured file types to be removed. </li><li><b>auto-rename</b> -
Automatically renames common artifact mistakes. </li><li><b>create-missing-
checksums</b> - Creates the md5 and sha1 checksum files of the artifact if
there are none available in the repository. </li><li><b>index-content</b> -
Adds the content of the artifact (specifically the pom) to the index, allowing
the artifact to be searched in Archiva.</li><li><b>metadata-updater</b> -
Updates artifact metadata files depending on the content of the repository.
</li><li><b>repository-purge</b> - Removes old snapshots from the repository
either by the number of days old or by the retention
count.</li><li><b>validate-checksums</b> - Validates the checksum files of the
artifact.</li><li><b>create-archiva-metadata</b> - Take an artifact off of disk
and put it into the metadata repository.</li><li><b>duplicate-artifacts</b> -
Search the artifact repository of known SHA1 Checksums for potential duplicate
artifacts.</li></ul><img src="../images/consumers.png" alt="" /></div></div>
</div>
</div>
</div>
Modified: archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/repositories.html
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/repositories.html?rev=1391332&r1=1391331&r2=1391332&view=diff
==============================================================================
--- archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/repositories.html
(original)
+++ archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/repositories.html Fri
Sep 28 06:57:17 2012
@@ -380,7 +380,7 @@ pageTracker._trackPageview();</script>
<div id="bodyColumn" class="span10" >
- <!-- Licensed to the Apache Software Foundation (ASF) under one
--><!-- or more contributor license agreements. See the NOTICE file --><!--
distributed with this work for additional information --><!-- regarding
copyright ownership. The ASF licenses this file --><!-- to you 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. --><!-- NOTE: For help
with the syntax of this file, see: --><!-- http://maven.apache.org/guides/mi
ni/guide-apt-format.html --><div class="section"><h2>Understanding Repository
Configuration of Apache Archiva<a
name="Understanding_Repository_Configuration_of_Apache_Archiva"></a></h2><!--
TODO: revise more as suggested by Jeff in the dev list --><p>Archiva has two
types of repository configuration: managed repository and remote
repository.</p><div class="section"><h3>Managed Repository<a
name="Managed_Repository"></a></h3><p>A managed repository is a repository
which resides locally to the server where Archiva is running. It could serve as
a proxy repository, an internal deployment repository or a local mirror
repository.</p><p>Managed repository fields:</p><ul><li><i>identifier</i> - the
id of the repository. This must be unique.</li><li><i>name</i> - the name of
the repository.</li><li><i>directory</i> - the location of the repository. If
the path specified does not exist, Archiva will create the missing
directories.</li><li><i>index directory</i> - the location of the i
ndex files generated by Archiva. If no location is specified, then the index
directory (named <tt>.indexer</tt>) will be created at the root of the
repository directory. Another directory named <tt>.index</tt> is also created
at the root of the repository directory. This is not configurable though as it
contains the packaged/bundled index which is consumed by different consumers of
the index such as M2Eclipse.</li><li><i>type</i> - the repository layout (maven
2 or maven 1)</li><li><i>cron</i> - the <a class="externalLink"
href="http://quartz.sourceforge.net/javadoc/org/quartz/CronTrigger.html";>cron
schedule</a> when repository scanning will be executed.</li><li><i>repository
purge by days older</i> - the first option for repository purge. Archiva will
check how old the artifact is and if it is older than the set number of days in
this field, then the artifact will be deleted respecting the retention count
(see #7) of course. In order to disable the purge by number of days o
ld and set Archiva to purge by retention count, just set the repository purge
field to 0. The maximum number of days which can be set here is 1000. See the
Repository Purge section below for more details.</li><li><i>repository purge by
retention count</i> - the second option for repository purge. When running the
repository purge, Archiva will retain only the number of artifacts set for this
field for a specific snapshot version. See the Repository Purge section below
for more details.</li><li><i>releases included</i> - specifies whether there
are released artifacts in the repository.</li><li><i>block re-deployment of
released artifacts</i> - specifies whether released artifacts that are already
existing in the repository can be overwritten. Note that this only take effects
for non-snapshot deployments.</li><li><i>snapshots included</i> - specifies
whether there are snapshot artifacts in the
repository.</li><li><i>scannable</i> - specifies whether the repository can be
scann
ed, meaning it is a local repository which can be indexed, browsed, purged,
etc.</li><li><i>delete released snapshots</i> - specifies whether to remove
those snapshot artifacts which already has release versions of it in the
repository during repository purge.</li></ul><p>Each repository has its own
Webdav url. This allows the user to browse and access the repository via
webdav. The url has the following format:</p><div class="source"><pre
class="prettyprint">http://[URL TO ARCHIVA]/repository/[REPOSITORY ID] (e.g.
http://localhost:8080/archiva/repository/releases).</pre></div><p>A pom snippet
is also available for each repository. The <distributionManagement>
section can be copied and pasted into a project's pom to specify that the
project will be deployed in that managed repository. The <repositories>
section on the other hand, can be copied and pasted to a project's pom.xml or
to Maven's settings.xml to tell Maven to get artifacts from the managed
repository w
hen building the project.</p></div><div class="section"><h3>Remote
Repository<a name="Remote_Repository"></a></h3><p>A remote repository is a
repository which resides remotely. These repositories are usually the proxied
repositories. See Proxy Connectors on how to proxy a repository.</p><p>Remote
repository fields:</p><ul><li><i>identifier</i> - the id of the remote
repository.</li><li><i>name</i> - the name of the remote
repository.</li><li><i>url</i> - the url of the remote repository. It is also
possible to use a 'file://' url to proxy a local repository. Be careful that if
this local repository is a managed repository of archiva which has some proxies
connectors, those ones won't be triggered.</li><li><i>username</i> - the
username (if authentication is needed) to be used to access the
repository.</li><li><i>password</i> - the password (if authentication is
needed) to be used to access the repository.</li><li><i>type</i> - the layout
(maven 2 or maven 1) of the remote re
pository.</li><li><i>Activate download remote index</i> - to activate
downloading remote index to add available remote artifacts in search
queries.</li><li><i>Remote index url, can be relative to url</i> - path of the
remote index directory.</li><li><i>Cron expression</i> - cron expression for
downloading remote index (default weekly on sunday)</li><li><i>Directory index
storage</i> - path to store index directory, default will be $<a
name="appserver.base">appserver.base</a>/data/remotes/$<a
name="repositoryId">repositoryId</a>/.index</li><li><i>Download Remote Index
Timeout in seconds</i> - read time out for downloading remote index files
(default 300)</li><li><i>Network Proxy to Use for download Remote Index</i> -
proxy to use for downloading remote index files.<img
src="../images/remote-repositories.png" alt="Remote Repositories" /><p>You can
also trigger an immediate download of remote index
files.</p></li></ul></div><div class="section"><h3>Scanning a Repository<a name=
"Scanning_a_Repository"></a></h3><p>Repository scan can be executed on
schedule or it can be explicitly executed by clicking the 'Scan Repository Now'
button in the repositories page. By default, Archiva only processes new
artifacts in the repository with respect to the last run of the repository
scanner. Meaning that if the artifact's last modified date is newer than the
last repository scan, then the artifact will be processed. Otherwise, it will
be skipped. You can override this behavior and force Archiva to process all
artifacts regardless of its age by ticking the 'Process All Artifacts' checkbox
in the repositories page and clicking the 'Scan Repository Now' button.</p><img
src="../images/repositories.png" alt="Repositories" /><p>For every artifact
found by the repository scanner, processing is done on this artifact by
different consumers. Examples of the processing done are: indexing, repository
purge and database update. Details about consumers are available in the <
a href="./consumers.html"> Consumers</a> page.</p></div><div
class="section"><h3>Repository Purge<a
name="Repository_Purge"></a></h3><p>Repository purge is the process of cleaning
up the repository of old snapshots. When deploying a snapshot to a repository,
Maven deploys the project/artifact with a timestamped version. Doing
daily/nightly builds of the project then tends to bloat the repository. What if
the artifact is large? Then disk space will definitely be a problem. That's
where Archiva's repository purge feature comes in. Given a criteria to use --
by the number of days old and by retention count, it would clean up the
repository by removing old snapshots.</p><p>Please take note that the by number
of days old criteria is activated by default (set to 100 days). In order to
de-activate it and use the by retention count criteria, you must set the
Repository Purge By Days Older field to 0. Another thing to note here is that
if the by number of days old criteria is activat
ed, the retention count would still be respected (See the Repository Purge By
Days Older section below for more details) but not the other way
around.</p><p>Let's take a look at different behaviours for repository purge
using the following scenario:</p><div class="source"><pre
class="prettyprint">Artifacts in the repository:
+ <!-- Licensed to the Apache Software Foundation (ASF) under one
--><!-- or more contributor license agreements. See the NOTICE file --><!--
distributed with this work for additional information --><!-- regarding
copyright ownership. The ASF licenses this file --><!-- to you 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. --><!-- NOTE: For help
with the syntax of this file, see: --><!-- http://maven.apache.org/guides/mi
ni/guide-apt-format.html --><div class="section"><h2>Understanding Repository
Configuration of Apache Archiva<a
name="Understanding_Repository_Configuration_of_Apache_Archiva"></a></h2><!--
TODO: revise more as suggested by Jeff in the dev list --><p>Archiva has two
types of repository configuration: managed repository and remote
repository.</p><div class="section"><h3>Managed Repository<a
name="Managed_Repository"></a></h3><p>A managed repository is a repository
which resides locally to the server where Archiva is running. It could serve as
a proxy repository, an internal deployment repository or a local mirror
repository.</p><p>Managed repository fields:</p><ul><li><b>identifier</b> - the
id of the repository. This must be unique.</li><li><b>name</b> - the name of
the repository.</li><li><b>directory</b> - the location of the repository. If
the path specified does not exist, Archiva will create the missing
directories.</li><li><b>index directory</b> - the location of the i
ndex files generated by Archiva. If no location is specified, then the index
directory (named <tt>.indexer</tt>) will be created at the root of the
repository directory. Another directory named <tt>.index</tt> is also created
at the root of the repository directory. This is not configurable though as it
contains the packaged/bundled index which is consumed by different consumers of
the index such as M2Eclipse.</li><li><b>type</b> - the repository layout (maven
2 or maven 1)</li><li><b>cron</b> - the <a class="externalLink"
href="http://quartz-scheduler.org/api/2.1.5/org/quartz/CronTrigger.html";>cron
schedule</a> when repository scanning will be executed.</li><li><b>repository
purge by days older</b> - the first option for repository purge. Archiva will
check how old the artifact is and if it is older than the set number of days in
this field, then the artifact will be deleted respecting the retention count of
course. In order to disable the purge by number of days old and se
t Archiva to purge by retention count, just set the repository purge field to
0. The maximum number of days which can be set here is 1000. See the Repository
Purge section below for more details.</li></ul><!-- above was:the retention
count (see #7) of course no idea what is was linkeed to
--><ul><li><b>repository purge by retention count</b> - the second option for
repository purge. When running the repository purge, Archiva will retain only
the number of artifacts set for this field for a specific snapshot version. See
the Repository Purge section below for more details.</li><li><b>releases
included</b> - specifies whether there are released artifacts in the
repository.</li><li><b>block re-deployment of released artifacts</b> -
specifies whether released artifacts that are already existing in the
repository can be overwritten. Note that this only take effects for
non-snapshot deployments.</li><li><b>snapshots included</b> - specifies whether
there are snapshot artifacts in
the repository.</li><li><b>scannable</b> - specifies whether the repository
can be scanned, meaning it is a local repository which can be indexed, browsed,
purged, etc.</li><li><b>delete released snapshots</b> - specifies whether to
remove those snapshot artifacts which already has release versions of it in the
repository during repository purge.</li></ul><p>Each repository has its own
Webdav url. This allows the user to browse and access the repository via
webdav. The url has the following format:</p><div class="source"><pre
class="prettyprint">http://[URL TO ARCHIVA]/repository/[REPOSITORY ID] (e.g.
http://localhost:8080/archiva/repository/releases).</pre></div><p>A pom snippet
is also available for each repository. The <distributionManagement>
section can be copied and pasted into a project's pom to specify that the
project will be deployed in that managed repository. The <repositories>
section on the other hand, can be copied and pasted to a project's pom.xml
or to Maven's settings.xml to tell Maven to get artifacts from the managed
repository when building the project.</p></div><div class="section"><h3>Remote
Repository<a name="Remote_Repository"></a></h3><p>A remote repository is a
repository which resides remotely. These repositories are usually the proxied
repositories. See Proxy Connectors on how to proxy a repository.</p><p>Remote
repository fields:</p><ul><li><b>identifier</b> - the id of the remote
repository.</li><li><b>name</b> - the name of the remote
repository.</li><li><b>url</b> - the url of the remote repository. It is also
possible to use a 'file://' url to proxy a local repository. Be careful that if
this local repository is a managed repository of archiva which has some proxies
connectors, those ones won't be triggered.</li><li><b>username</b> - the
username (if authentication is needed) to be used to access the
repository.</li><li><b>password</b> - the password (if authentication is
needed) to be used to acces
s the repository.</li><li><b>type</b> - the layout (maven 2 or maven 1) of the
remote repository.</li><li><b>Activate download remote index</b> - to activate
downloading remote index to add available remote artifacts in search
queries.</li><li><b>Remote index url, can be relative to url</b> - path of the
remote index directory.</li><li><b>Cron expression</b> - cron expression for
downloading remote index (default weekly on sunday)</li><li><b>Directory index
storage</b> - path to store index directory, default will be
${appserver.base}/data/remotes/${repositoryId}/.index</li><li><b>Download
Remote Index Timeout in seconds</b> - read time out for downloading remote
index files (default 300)</li><li><b>Network Proxy to Use for download Remote
Index</b> - proxy to use for downloading remote index files.<img
src="../images/remote-repositories.png" alt="Remote Repositories" /><p>You can
also trigger an immediate download of remote index
files.</p></li></ul></div><div class="sectio
n"><h3>Scanning a Repository<a
name="Scanning_a_Repository"></a></h3><p>Repository scan can be executed on
schedule or it can be explicitly executed by clicking the 'Scan Repository Now'
button in the repositories page. By default, Archiva only processes new
artifacts in the repository with respect to the last run of the repository
scanner. Meaning that if the artifact's last modified date is newer than the
last repository scan, then the artifact will be processed. Otherwise, it will
be skipped. You can override this behavior and force Archiva to process all
artifacts regardless of its age by ticking the 'Process All Artifacts' checkbox
in the repositories page and clicking the 'Scan Repository Now' button.</p><img
src="../images/repositories.png" alt="Repositories" /><p>For every artifact
found by the repository scanner, processing is done on this artifact by
different consumers. Examples of the processing done are: indexing, repository
purge and database update. Details ab
out consumers are available in the <a href="./consumers.html"> Consumers</a>
page.</p></div><div class="section"><h3>Repository Purge<a
name="Repository_Purge"></a></h3><p>Repository purge is the process of cleaning
up the repository of old snapshots. When deploying a snapshot to a repository,
Maven deploys the project/artifact with a timestamped version. Doing
daily/nightly builds of the project then tends to bloat the repository. What if
the artifact is large? Then disk space will definitely be a problem. That's
where Archiva's repository purge feature comes in. Given a criteria to use --
by the number of days old and by retention count, it would clean up the
repository by removing old snapshots.</p><p>Please take note that the by number
of days old criteria is activated by default (set to 100 days). In order to
de-activate it and use the by retention count criteria, you must set the
Repository Purge By Days Older field to 0. Another thing to note here is that
if the by nu
mber of days old criteria is activated, the retention count would still be
respected (See the Repository Purge By Days Older section below for more
details) but not the other way around.</p><p>Let's take a look at different
behaviours for repository purge using the following scenario:</p><div
class="source"><pre class="prettyprint">Artifacts in the repository:
../artifact-x/2.0-SNAPSHOT/artifact-x-20061118.060401-2.jar
../artifact-x/2.0-SNAPSHOT/artifact-x-20061118.060401-2.pom
Modified: archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/webapp.html
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/webapp.html?rev=1391332&r1=1391331&r2=1391332&view=diff
==============================================================================
--- archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/webapp.html (original)
+++ archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/webapp.html Fri Sep 28
06:57:17 2012
@@ -350,17 +350,17 @@ pageTracker._trackPageview();</script>
<Resource name="mail/Session" auth="Container"
type="javax.mail.Session"
mail.smtp.host="localhost"/>
- </Context></pre></div></li><li>Install <tt>derby-10.1.3.1.jar</tt> (or
later), <tt>activation-1.1.jar</tt> and <tt>mail-1.4.jar</tt> into the Tomcat
5.5 <tt>common/lib</tt> or Tomcat 6.0 <tt>lib</tt> directory. This is required
since the data sources are instantiated before the web
application.<p><b>Note</b>: Tomcat 5.5.20 and 5.5.23 are missing
MailSessionFactory and a few other classes. JNDI mail sessions will <i>not</i>
work. Use Tomcat 5.5.25 instead, or see <a class="externalLink"
href="http://issues.apache.org/bugzilla/show_bug.cgi?id=40668";> Bug 40668</a>
for a workaround.</p></li><li>The $<a name="appserver.base">appserver.base</a>
java property is used by the Archiva internal logging configuration to
determine where to output its logs to. It is important to define this property
either in the $CATALINA_OPTS system environment variable if Tomcat is being
launched via the command line) or the service properties (if being launched as
a service or daemon). The for
mat typically expected is -Dappserver.base=<i>SOMEWHERE</i>. In this example,
we'll put the logs in Tomcat's <tt>logs</tt> directory so we need to set
appserver.base property to where Tomcat is installed:<div class="source"><pre
class="prettyprint">export CATALINA_OPTS="-Dappserver.home=$CATALINA_HOME
-Dappserver.base=$CATALINA_HOME" (for UNIX)
+ </Context></pre></div></li><li>Install <tt>derby-10.1.3.1.jar</tt> (or
later), <tt>activation-1.1.jar</tt> and <tt>mail-1.4.jar</tt> into the Tomcat
5.5 <tt>common/lib</tt> or Tomcat 6.0 <tt>lib</tt> directory. This is required
since the data sources are instantiated before the web
application.<p><b>Note</b>: Tomcat 5.5.20 and 5.5.23 are missing
MailSessionFactory and a few other classes. JNDI mail sessions will <i>not</i>
work. Use Tomcat 5.5.25 instead, or see <a class="externalLink"
href="http://issues.apache.org/bugzilla/show_bug.cgi?id=40668";> Bug 40668</a>
for a workaround.</p></li><li>The ${appserver.base} java property is used by
the Archiva internal logging configuration to determine where to output its
logs to. It is important to define this property either in the $CATALINA_OPTS
system environment variable if Tomcat is being launched via the command line)
or the service properties (if being launched as a service or daemon). The
format typically expected is -
Dappserver.base=<i>SOMEWHERE</i>. In this example, we'll put the logs in
Tomcat's <tt>logs</tt> directory so we need to set appserver.base property to
where Tomcat is installed:<div class="source"><pre class="prettyprint">export
CATALINA_OPTS="-Dappserver.home=$CATALINA_HOME
-Dappserver.base=$CATALINA_HOME" (for UNIX)
OR
-set CATALINA_OPTS="-Dappserver.home=%CATALINA_HOME%
-Dappserver.base=%CATALINA_HOME%" (for Windows)</pre></div></li><li>If
setting the $<a name="appserver.base">appserver.base</a> and $<a
name="appserver.home">appserver.home</a> using the previous step does not work,
you can set it in the unpacked Archiva web application's
<tt>WEB-INF/classes/application.properties</tt> as follows:<div
class="source"><pre class="prettyprint"># for Windows:
+set CATALINA_OPTS="-Dappserver.home=%CATALINA_HOME%
-Dappserver.base=%CATALINA_HOME%" (for Windows)</pre></div></li><li>If
setting the ${appserver.base} and ${appserver.home} using the previous step
does not work, you can set it in the unpacked Archiva web application's
<tt>WEB-INF/classes/application.properties</tt> as follows:<div
class="source"><pre class="prettyprint"># for Windows:
appserver.base=%CATALINA_HOME%
appserver.base=%CATALINA_BASE%
# or, for UNIX:
appserver.base=$CATALINA_HOME
-appserver.home=$CATALINA_BASE</pre></div></li><li>When running Tomcat as a
<b>Windows</b> service, you need to edit <tt>regedit</tt> and then, in
<tt>HKEY_LOCAL_MACHINE > SOFTWARE > Apache Software Foundation >
Procrun 2.0 > TomcatX > Parameters > Java</tt>, modify the
<tt>Options</tt> variable. Set the $<a name="appserver.base">appserver.base</a>
property by adding the following parameters at the end:<div class="source"><pre
class="prettyprint">-Dappserver.base=%CATALINA_HOME%
-Dappserver.home=%CATALINA_HOME%</pre></div></li></ul><p>For more information,
see <a class="externalLink"
href="http://cwiki.apache.org/confluence/display/ARCHIVA/Archiva+on+Tomcat";>
Archiva on Tomcat</a> in the wiki.</p></div><div class="section"><h2>Archiva
Configuration<a name="Archiva_Configuration"></a></h2><p>Archiva is configured
using the <tt>~/.m2/archiva.xml</tt> configuration file by default when using a
Java EE application server. </p><!-- TODO: how to configure the othe
r file --></div><div class="section"><h2>Upgrading Archiva<a
name="Upgrading_Archiva"></a></h2><p>To upgrade the Archiva web application,
simply replace the web application with an alternative. Since the database and
configuration files are stored externally to the application, no further
maintainance is needed.</p><p>For general information about upgrading Archiva,
see the relevant section in the <a href="./standalone.html#Upgrading20Archiva">
Installing standalone</a> guide.</p></div><div class="section"><h2>Configuring
and Running Archiva<a name="Configuring_and_Running_Archiva"></a></h2><p>Once
Archiva is running, it is configured in the same way as the standalone
instance. See the <a
href="../quick-start.html#Setting20up20your20Archiva20instance"> quick
start</a> guide for more information.</p></div><div
class="section"><h2>Troubleshooting<a name="Troubleshooting"></a></h2><div
class="section"><h3>Error During Startup<a
name="Error_During_Startup"></a></h3><p>There are
cases when the Tomcat logs only shows the following error during
startup:</p><div class="source"><pre class="prettyprint">...
+appserver.home=$CATALINA_BASE</pre></div></li><li>When running Tomcat as a
<b>Windows</b> service, you need to edit <tt>regedit</tt> and then, in
<tt>HKEY_LOCAL_MACHINE > SOFTWARE > Apache Software Foundation >
Procrun 2.0 > TomcatX > Parameters > Java</tt>, modify the
<tt>Options</tt> variable. Set the ${appserver.base} property by adding the
following parameters at the end:<div class="source"><pre
class="prettyprint">-Dappserver.base=%CATALINA_HOME%
-Dappserver.home=%CATALINA_HOME%</pre></div></li></ul><p>For more information,
see <a class="externalLink"
href="http://cwiki.apache.org/confluence/display/ARCHIVA/Archiva+on+Tomcat";>
Archiva on Tomcat</a> in the wiki.</p></div><div class="section"><h2>Archiva
Configuration<a name="Archiva_Configuration"></a></h2><p>Archiva is configured
using the <tt>~/.m2/archiva.xml</tt> configuration file by default when using a
Java EE application server. </p><!-- TODO: how to configure the other file
--></div><div class=
"section"><h2>Upgrading Archiva<a name="Upgrading_Archiva"></a></h2><p>To
upgrade the Archiva web application, simply replace the web application with an
alternative. Since the database and configuration files are stored externally
to the application, no further maintainance is needed.</p><p>For general
information about upgrading Archiva, see the relevant section in the <a
href="./standalone.html#Upgrading20Archiva"> Installing standalone</a>
guide.</p></div><div class="section"><h2>Configuring and Running Archiva<a
name="Configuring_and_Running_Archiva"></a></h2><p>Once Archiva is running, it
is configured in the same way as the standalone instance. See the <a
href="../quick-start.html#Setting20up20your20Archiva20instance"> quick
start</a> guide for more information.</p></div><div
class="section"><h2>Troubleshooting<a name="Troubleshooting"></a></h2><div
class="section"><h3>Error During Startup<a
name="Error_During_Startup"></a></h3><p>There are cases when the Tomcat logs
only shows the following error during startup:</p><div class="source"><pre
class="prettyprint">...
Aug 17, 2009 11:04:02 AM org.apache.catalina.core.StandardContext start
SEVERE: Error listenerStart
Aug 17, 2009 11:04:02 AM org.apache.catalina.core.StandardContext start
Modified: archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/deploy.html
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/deploy.html?rev=1391332&r1=1391331&r2=1391332&view=diff
==============================================================================
--- archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/deploy.html (original)
+++ archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/deploy.html Fri Sep 28
06:57:17 2012
@@ -313,7 +313,7 @@ pageTracker._trackPageview();</script>
<div id="bodyColumn" class="span10" >
- <!-- Licensed to the Apache Software Foundation (ASF) under one
--><!-- or more contributor license agreements. See the NOTICE file --><!--
distributed with this work for additional information --><!-- regarding
copyright ownership. The ASF licenses this file --><!-- to you 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. --><!-- NOTE: For help
with the syntax of this file, see: --><!-- http://maven.apache.org/guides/mi
ni/guide-apt-format.html --><div class="section"><h2>Deploying to Repository<a
name="Deploying_to_Repository"></a></h2><p>There are different ways on how you
can deploy artifacts in an Archiva repository. </p><ul><li><a
href="#Maven">Maven</a> Configuring Maven to deploy to an Archiva
repository}}</li><li><a href="#Web_UI">Web UI</a> Deploying via the Web UI
Form}}</li></ul><p>Starting with Archiva 1.2.3, it is possible to block
re-deployment of released artifacts to a specific repository. This can be
configured through the repository configuration page by ticking the <tt>Block
Re-deployment of Released Artifacts</tt> checkbox.</p><p><b>WARNING</b> The
deployed artifact may not appear immediately in the search results. The
execution of the <tt>index-content</tt> repository consumer and other scanning
consumers are queued for execution to prevent concurrent updates to the
index.</p><div class="section"><h3>Configuring <a name="Maven">Maven</a> to
deploy to an Archiva reposito
ry<a name="Configuring_Maven_to_deploy_to_an_Archiva_repository"></a></h3><ol
style="list-style-type: decimal"><li>Create a user in Archiva to use for
deployment (or use guest if you wish to deploy without a username and
password)</li><li>The deployment user needs the Role 'Repository Manager' for
each repository that you want to deploy to</li><li>Define the server for
deployment inside your 'settings.xml', use the newly created user for
authentication<div class="source"><pre class="prettyprint"><settings>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one
--><!-- or more contributor license agreements. See the NOTICE file --><!--
distributed with this work for additional information --><!-- regarding
copyright ownership. The ASF licenses this file --><!-- to you 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. --><!-- NOTE: For help
with the syntax of this file, see: --><!-- http://maven.apache.org/guides/mi
ni/guide-apt-format.html --><div class="section"><h2>Deploying to Repository<a
name="Deploying_to_Repository"></a></h2><p>There are different ways on how you
can deploy artifacts in an Archiva repository. </p><ul><li><a
href="#Maven">Maven</a> Configuring Maven to deploy to an Archiva
repository</li><li><a href="#Web_UI">Web UI</a> Deploying via the Web UI
Form</li></ul><p>Starting with Archiva 1.2.3, it is possible to block
re-deployment of released artifacts to a specific repository. This can be
configured through the repository configuration page by ticking the <tt>Block
Re-deployment of Released Artifacts</tt> checkbox.</p><p><b>WARNING</b> The
deployed artifact may not appear immediately in the search results. The
execution of the <tt>index-content</tt> repository consumer and other scanning
consumers are queued for execution to prevent concurrent updates to the
index.</p><div class="section"><h3>Configuring <a name="Maven">Maven</a> to
deploy to an Archiva repository<a
name="Configuring_Maven_to_deploy_to_an_Archiva_repository"></a></h3><ol
style="list-style-type: decimal"><li>Create a user in Archiva to use for
deployment (or use guest if you wish to deploy without a username and
password)</li><li>The deployment user needs the Role 'Repository Manager' for
each repository that you want to deploy to</li><li>Define the server for
deployment inside your 'settings.xml', use the newly created user for
authentication<div class="source"><pre class="prettyprint"><settings>
<!-- omitted xml -->
<servers>
<server>
Modified:
archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/using-repository.html
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/using-repository.html?rev=1391332&r1=1391331&r2=1391332&view=diff
==============================================================================
--- archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/using-repository.html
(original)
+++ archiva/site-content/docs/1.4-M3-SNAPSHOT/userguide/using-repository.html
Fri Sep 28 06:57:17 2012
@@ -312,7 +312,7 @@ pageTracker._trackPageview();</script>
<div id="bodyColumn" class="span10" >
- <!-- Licensed to the Apache Software Foundation (ASF) under one
--><!-- or more contributor license agreements. See the NOTICE file --><!--
distributed with this work for additional information --><!-- regarding
copyright ownership. The ASF licenses this file --><!-- to you 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. --><div
class="section"><h2>Configuring Maven 2 to use an Archiva repository<a
name="Configuring_Ma
ven_2_to_use_an_Archiva_repository"></a></h2><p>To get your local Maven 2
installation to use an Archiva proxy you need to add the repositories you
require to your 'settings.xml'. This file is usually found in $<a
name="user.dir">user.dir</a>/.m2/settings.xml (see the <a class="externalLink"
href="http://maven.apache.org/settings.html";>Settings Reference</a>).
</p><p>How you configure the settings depends on how you would like to utilise
the repository. You can add the Archiva repository as an additional repository
to others already declared by the project, or lock down the environment to only
use the Archiva repositories (possibly proxying content from a remote
repository).</p><div class="section"><h3>Locking down to only use Archiva<a
name="Locking_down_to_only_use_Archiva"></a></h3><p>If you would like Archiva
to serve as the only repository used by your Maven installation, you can use
the Maven mirror settings to force this behaviour.</p><p>First, you need to
select the
default repository to use when none is configured by adding the following to
the <tt>settings.xml</tt> file:</p><div class="source"><pre
class="prettyprint"><settings>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one
--><!-- or more contributor license agreements. See the NOTICE file --><!--
distributed with this work for additional information --><!-- regarding
copyright ownership. The ASF licenses this file --><!-- to you 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. --><div
class="section"><h2>Configuring Maven 2 to use an Archiva repository<a
name="Configuring_Ma
ven_2_to_use_an_Archiva_repository"></a></h2><p>To get your local Maven 2
installation to use an Archiva proxy you need to add the repositories you
require to your 'settings.xml'. This file is usually found in
${user.dir}/.m2/settings.xml (see the <a class="externalLink"
href="http://maven.apache.org/settings.html";>Settings Reference</a>).
</p><p>How you configure the settings depends on how you would like to utilise
the repository. You can add the Archiva repository as an additional repository
to others already declared by the project, or lock down the environment to only
use the Archiva repositories (possibly proxying content from a remote
repository).</p><div class="section"><h3>Locking down to only use Archiva<a
name="Locking_down_to_only_use_Archiva"></a></h3><p>If you would like Archiva
to serve as the only repository used by your Maven installation, you can use
the Maven mirror settings to force this behaviour.</p><p>First, you need to
select the default repository to
use when none is configured by adding the following to the
<tt>settings.xml</tt> file:</p><div class="source"><pre
class="prettyprint"><settings>
<!-- omitted xml -->
<mirrors>
<mirror>
