Author: olamy
Date: Mon Oct 15 12:21:23 2012
New Revision: 1398265
URL: http://svn.apache.org/viewvc?rev=1398265&view=rev
Log:
Apache Archiva Versionned docs for 1.4-M4-SNAPSHOT
Modified:
archiva/site-content/docs/1.4-M4-SNAPSHOT/adminguide/repositories.html
Modified: archiva/site-content/docs/1.4-M4-SNAPSHOT/adminguide/repositories.html
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M4-SNAPSHOT/adminguide/repositories.html?rev=1398265&r1=1398264&r2=1398265&view=diff
==============================================================================
--- archiva/site-content/docs/1.4-M4-SNAPSHOT/adminguide/repositories.html
(original)
+++ archiva/site-content/docs/1.4-M4-SNAPSHOT/adminguide/repositories.html Mon
Oct 15 12:21:23 2012
@@ -387,7 +387,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><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
class="section"><h4
>Maven Index from Remote repositories<a
>name="Maven_Index_from_Remote_repositories"></a></h4><p>If you have
>configured download remote index, those files (Maven Indexer project format)
>will be available in the path http://archiva/repository/id/.index (you can
>consume those files for IDE)</p></div></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 pa
ge 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 t
he 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 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:
+ <!-- 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
class="section"><h4
>Maven Index from Remote repositories<a
>name="Maven_Index_from_Remote_repositories"></a></h4><p><b>Since 1.4-M4</b>:
>If you have configured download remote index, those files (Maven Indexer
>project format) will be available in the path
>http://archiva/repository/id/.index (you can consume those files for
>IDE)</p></div></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 i
n 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 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
