summaryrefslogtreecommitdiffstats
path: root/archiva-site/src/site/apt
diff options
context:
space:
mode:
authorBrett Porter <brett@apache.org>2007-11-21 08:26:57 +0000
committerBrett Porter <brett@apache.org>2007-11-21 08:26:57 +0000
commit7f5caf2ec745e4f9068c31876d85b620e80cf29b (patch)
tree77f1bf244754efc1bbc07d2d54c609214b586ef9 /archiva-site/src/site/apt
parent5689b7a1344b34869a494bd4a5140c4baf24f3d2 (diff)
downloadarchiva-7f5caf2ec745e4f9068c31876d85b620e80cf29b.tar.gz
archiva-7f5caf2ec745e4f9068c31876d85b620e80cf29b.zip
site -> docs
git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@596980 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'archiva-site/src/site/apt')
-rw-r--r--archiva-site/src/site/apt/adminguide/configuration-files.apt8
-rw-r--r--archiva-site/src/site/apt/adminguide/configuration.apt8
-rw-r--r--archiva-site/src/site/apt/adminguide/consumers.apt8
-rw-r--r--archiva-site/src/site/apt/adminguide/databases.apt11
-rw-r--r--archiva-site/src/site/apt/adminguide/index.apt8
-rw-r--r--archiva-site/src/site/apt/adminguide/installing.apt9
-rw-r--r--archiva-site/src/site/apt/adminguide/network-proxies.apt8
-rw-r--r--archiva-site/src/site/apt/adminguide/proxy-connectors.apt8
-rw-r--r--archiva-site/src/site/apt/adminguide/reports.apt66
-rw-r--r--archiva-site/src/site/apt/adminguide/repositories.apt159
-rw-r--r--archiva-site/src/site/apt/adminguide/roles.apt8
-rw-r--r--archiva-site/src/site/apt/adminguide/security.apt8
-rw-r--r--archiva-site/src/site/apt/adminguide/standalone.apt11
-rw-r--r--archiva-site/src/site/apt/adminguide/webapp.apt11
-rw-r--r--archiva-site/src/site/apt/customising/writing-consumer.apt8
-rw-r--r--archiva-site/src/site/apt/guides/configuration.apt63
-rw-r--r--archiva-site/src/site/apt/guides/getting-started.apt120
-rw-r--r--archiva-site/src/site/apt/guides/maven-configuration.apt267
-rw-r--r--archiva-site/src/site/apt/guides/security-configuration.apt126
-rw-r--r--archiva-site/src/site/apt/index.apt25
-rw-r--r--archiva-site/src/site/apt/quick-start.apt8
-rw-r--r--archiva-site/src/site/apt/userguide/browsing.apt70
-rw-r--r--archiva-site/src/site/apt/userguide/deploy.apt8
-rw-r--r--archiva-site/src/site/apt/userguide/find-artifact.apt8
-rw-r--r--archiva-site/src/site/apt/userguide/index.apt8
-rw-r--r--archiva-site/src/site/apt/userguide/searching.apt8
-rw-r--r--archiva-site/src/site/apt/userguide/using-repository.apt8
27 files changed, 0 insertions, 1058 deletions
diff --git a/archiva-site/src/site/apt/adminguide/configuration-files.apt b/archiva-site/src/site/apt/adminguide/configuration-files.apt
deleted file mode 100644
index 8f9518389..000000000
--- a/archiva-site/src/site/apt/adminguide/configuration-files.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Configuration Files of Apache Archiva
- ------
-
-Configuration Files of Apache Archiva
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/adminguide/configuration.apt b/archiva-site/src/site/apt/adminguide/configuration.apt
deleted file mode 100644
index 990b1a810..000000000
--- a/archiva-site/src/site/apt/adminguide/configuration.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Runtime Configuration of Apache Archiva
- ------
-
-Runtime Configuration of Apache Archiva
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/adminguide/consumers.apt b/archiva-site/src/site/apt/adminguide/consumers.apt
deleted file mode 100644
index 20be04b49..000000000
--- a/archiva-site/src/site/apt/adminguide/consumers.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Understanding Consumers in Apache Archiva
- ------
-
-Understanding Consumers in Apache Archiva
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/adminguide/databases.apt b/archiva-site/src/site/apt/adminguide/databases.apt
deleted file mode 100644
index b1e001231..000000000
--- a/archiva-site/src/site/apt/adminguide/databases.apt
+++ /dev/null
@@ -1,11 +0,0 @@
- ------
- Apache Archiva Databases
- ------
-
-Apache Archiva Databases
-
- :STUB: This is a documentation stub.
-
-~~TODO: give general information on configuration for an external database
-~~TODO: use mysql or external derby as an example
-~~TODO: link to wiki location that does others
diff --git a/archiva-site/src/site/apt/adminguide/index.apt b/archiva-site/src/site/apt/adminguide/index.apt
deleted file mode 100644
index 9f255f611..000000000
--- a/archiva-site/src/site/apt/adminguide/index.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- System Administrators Guide to Apache Archiva
- ------
-
-System Administrators Guide to Apache Archiva
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/adminguide/installing.apt b/archiva-site/src/site/apt/adminguide/installing.apt
deleted file mode 100644
index 4005854f6..000000000
--- a/archiva-site/src/site/apt/adminguide/installing.apt
+++ /dev/null
@@ -1,9 +0,0 @@
- ------
- Installing Apache Archiva
- ------
-
-Installing Apache Archiva
-
- :STUB: This is a documentation stub.
-
-~~TODO: ensure upgrading is covered - does it need to be a separate doc
diff --git a/archiva-site/src/site/apt/adminguide/network-proxies.apt b/archiva-site/src/site/apt/adminguide/network-proxies.apt
deleted file mode 100644
index ba04fc4d6..000000000
--- a/archiva-site/src/site/apt/adminguide/network-proxies.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Understanding Network Proxy Configuration of Apache Archiva
- ------
-
-Understanding Network Proxy Configuration of Apache Archiva
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/adminguide/proxy-connectors.apt b/archiva-site/src/site/apt/adminguide/proxy-connectors.apt
deleted file mode 100644
index 0502b0ed4..000000000
--- a/archiva-site/src/site/apt/adminguide/proxy-connectors.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Understanding Proxy Connector Configuration of Apache Archiva
- ------
-
-Understanding Proxy Connector Configuration of Apache Archiva
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/adminguide/reports.apt b/archiva-site/src/site/apt/adminguide/reports.apt
deleted file mode 100644
index eb95a950b..000000000
--- a/archiva-site/src/site/apt/adminguide/reports.apt
+++ /dev/null
@@ -1,66 +0,0 @@
- ------
- Making the most of Reporting in Apache Archiva
- ------
- Maria Odea Ching
- ------
- 12 Nov 2007
- ------
-
-~~ 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/mini/guide-apt-format.html
-
-Making the most of Reporting in Apache Archiva
-
- Reporting in Archiva is currently limited to a detailed listing of the problematic artifacts in the different
- repositories. Problematic artifacts are those artifacts that were detected by Archiva to have defects (ex.
- the versions in the pom and in the artifact itself do not match).
-
-* Configuring a Report
-
- There are 3 fields which can be configured when viewing the reports. These are: the number of rows per page,
- the group id and the repository.
-
- 1. Setting the row count. This field is for configuring the number of rows or artifacts to be displayed per page
- of the report. By default, this is set to 100. The minimum number of rows per page is 10 and the maximum number
- of rows is 1000.
-
- 2. Setting the group id. The group id pertains to the group id of the artifact (ex. org.apache.maven.plugins).
- This field has a blank default value -- meaning, show defective artifacts which has any group id.
-
- 3. Setting the repository. You can view the defective artifacts found on specific repositories by setting the
- repository field. By default, it is set to All Repositories. Please note that the repository field options list
- only contains the repositories which have one or more defective artifacts in it. So not all the repositories
- you have configured in the Repositories section will show up in this list, unless of course they all contain
- defective artifacts.
-
-* Contents of a Report
-
- The Show Report button will display a detailed list of problematic artifacts filtered according to the
- configuration you've set. Below is a sample Archiva report:
-
-
-[../images/archiva-report.jpg] Archiva Report
-
- You can see in the sample report that there are links to the groupId and artifactId directories
- of each artifact. Clicking on any of these links will bring you to the appropriate navigation page in the
- Repository Browse. Going back to the report, shown below the links is the specific problem or defect of the
- artifact. These are usually detected during repository or database scanning. The page number is also displayed on
- the lower left-hand part of the report.
-
diff --git a/archiva-site/src/site/apt/adminguide/repositories.apt b/archiva-site/src/site/apt/adminguide/repositories.apt
deleted file mode 100644
index 0a8fc33d3..000000000
--- a/archiva-site/src/site/apt/adminguide/repositories.apt
+++ /dev/null
@@ -1,159 +0,0 @@
- ------
- Understanding Repository Configuration of Apache Archiva
- ------
- Maria Odea Ching
- ------
- 13 Nov 2007
- ------
-
-~~ 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/mini/guide-apt-format.html
-
-Understanding Repository Configuration of Apache Archiva
-
-~~NOTE TO MYSELF: Review this! and improve the format and the contents
-~~ Some parts sounds confusing to me (or am i just tired?)
-
- Archiva has two types of repository configuration: managed repository and remote repository.
-
-* Managed Repository
-
- 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.
-
- Managed repository fields:
-
- 1. identifier - the id of the repository. This must be unique.
-
- 2. name - the name of the repository.
-
- 3. directory - the location of the repository. If the path specified does not exist, Archiva will create the missing
- directories.
-
- 4. type - the repository layout (maven 2 or maven 1)
-
- 5. cron - the cron schedule when repository scanning will be executed.
-
- 6. repository purge by days older - 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 old 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.
-
- 7. repository purge by retention count - 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.
-
- 8. releases included - specifies whether there are released artifacts in the repository.
-
- 9. snapshots included - specifies whether there are snapshot artifacts in the repository.
-
- 10. scannable - specifies whether the repository can be scanned.
-
- 11. delete released snapshots - specifies whether to remove those snapshot artifacts which already has release versions
- of it in the repository during repository purge.
-
- 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:
-
-+----+
-http://[URL TO ARCHIVA]/repository/[REPOSITORY ID] (e.g. http://localhost:8080/archiva/repository/releases).
-+----+
-
- Managed repositories can be explicitly scanned by clicking the 'Scan Repository Now' button in the repositories page. 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.
-
- For more details about the repository purge from numbers 6 and 7 above, please take a look at the Repository Purge section
- below.
-
-* Remote Repository
-
- 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.
-
- Remote repository fields:
-
- 1. identifier - the id of the remote repository.
-
- 2. name - the name of the remote repository.
-
- 3. url - the url of the remote repository.
-
- 4. username - the username (if authentication is needed) to be used to access the repository.
-
- 5. password - the password (if authentication is needed) to be used to access the repository.
-
- 6. type - the layout (maven 2 or maven 1) of the remote repository.
-
-* Repository Purge
-
- 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.
-
- Let's take a look at different behaviours for repository purge using the following scenario:
-
-+----+
-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
-../artifact-x/2.0-SNAPSHOT/artifact-x-20070113.034619-3.jar
-../artifact-x/2.0-SNAPSHOT/artifact-x-20070113.034619-3.pom
-../artifact-x/2.0-SNAPSHOT/artifact-x-20070203.028902-4.jar
-../artifact-x/2.0-SNAPSHOT/artifact-x-20070203.028902-4.pom
-+----+
-
- 1. Repository Purge By Days Older
-
- Using this criteria for the purge, Archiva will check how old an artifact is and if it is older than the set value in the
- repository purge by days older field, then the artifact will be deleted respecting the retention count of course.
-
- If repository purge by days older is set to 100 days (with repository purge by retention count field set to 1),
- and the current date is let's say 03-01-2007, given the scenario above.. the following artifacts will be retained:
- artifact-x-20070113.034619-3.jar, artifact-x-20070113.034619-3.pom, artifact-x-20070203.028902-4.jar and
- artifact-x-20070203.028902-4.pom. It is clear in the version timestamps that these 4 artifacts are not more than
- 100 days old from the current date (which is 03-01-2007 in our example) so they are all retained. In this case
- the retention count doesn't have any effect since the priority is the age of the artifact.
-
- Now, if the repository purge by days older is set to 30 days (with repository purge by retention count field still
- set to 1) and the current date is still 03-01-2007, then given the same scenario above.. only the following artifacts
- will be retained: artifact-x-20070203.028902-4.jar and artifact-x-20070203.028902-4.pom. In this case, we can see
- that the retained artifacts are still not older by the number of days set in the repository purge by days older field
- and the retention count is still met.
-
- Now, let's set the repository purge by days older to 10 days (with repository purge by retention count field still
- set to 1) and the current date is still 03-01-2007, then still given the same repository contents above.. the
- following artifacts will still be retained: artifact-x-20070203.028902-4.jar and artifact-x-20070203.028902-4.pom.
- It is clear from the version timestamps that the artifacts ARE MORE THAN the repository purge by days older value,
- which is 10 days. Why is it still retained? Recall the value of the repository purge by retention count -- 1 :)
- This ensures that there is ALWAYS 1 artifact timestamped version retained for every unique version snapshot directory
- of an artifact.
-
- 2. Repository Purge By Retention Count
-
- If the repository purge by retention count field is set to 2, then only the artifacts artifact-x-20070113.034619-3.jar,
- artifact-x-20070113.034619-3.pom, artifact-x-20070203.028902-4.jar and artifact-x-20070203.028902-4.pom will be retained
- in the repository. The oldest snapshots will be deleted maintaining only a number of snapshots equivalent to the set
- retention count.
- \ No newline at end of file
diff --git a/archiva-site/src/site/apt/adminguide/roles.apt b/archiva-site/src/site/apt/adminguide/roles.apt
deleted file mode 100644
index 962303204..000000000
--- a/archiva-site/src/site/apt/adminguide/roles.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Understanding Apache Archiva Security Roles
- ------
-
-Understanding Apache Archiva Security Roles
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/adminguide/security.apt b/archiva-site/src/site/apt/adminguide/security.apt
deleted file mode 100644
index 33770e4b0..000000000
--- a/archiva-site/src/site/apt/adminguide/security.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Understanding Apache Archiva Security
- ------
-
-Understanding Apache Archiva Security
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/adminguide/standalone.apt b/archiva-site/src/site/apt/adminguide/standalone.apt
deleted file mode 100644
index 85ea30a29..000000000
--- a/archiva-site/src/site/apt/adminguide/standalone.apt
+++ /dev/null
@@ -1,11 +0,0 @@
- ------
- Installing Standalone Distribution of Apache Archiva
- ------
-
-Installing Standalone Distribution of Apache Archiva
-
- :STUB: This is a documentation stub.
-
-~~TODO: link to quick start as it covers the most basic scenario
-~~TODO: ensure to refer to advanced configuration options, such as PLEXUS_BASE
-
diff --git a/archiva-site/src/site/apt/adminguide/webapp.apt b/archiva-site/src/site/apt/adminguide/webapp.apt
deleted file mode 100644
index 8dc32a6a5..000000000
--- a/archiva-site/src/site/apt/adminguide/webapp.apt
+++ /dev/null
@@ -1,11 +0,0 @@
- ------
- Installing Apache Archiva as a Web Application
- ------
-
-Installing Apache Archiva as a Web Application
-
- :STUB: This is a documentation stub.
-
-~~TODO: show example using Tomcat 6.
-~~TODO: link to wiki location for other application servers
-
diff --git a/archiva-site/src/site/apt/customising/writing-consumer.apt b/archiva-site/src/site/apt/customising/writing-consumer.apt
deleted file mode 100644
index e61e95666..000000000
--- a/archiva-site/src/site/apt/customising/writing-consumer.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Writing a Custom Repository Consumer
- ------
-
-Writing a Custom Repository Consumer
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/guides/configuration.apt b/archiva-site/src/site/apt/guides/configuration.apt
deleted file mode 100644
index c307dff93..000000000
--- a/archiva-site/src/site/apt/guides/configuration.apt
+++ /dev/null
@@ -1,63 +0,0 @@
- ------
- Archiva Configuration
- ------
- The Maven Team
- ------
- 8 March 2007
- ------
-
-~~ 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/mini/guide-apt-format.html
-
-Archiva Configuration
-
-* Web Configuration
-
- Archiva can be fully configured from the web interface (with the exception of the {{{security-configuration.html} security properties, presently}}).
-
- ...
-
-~~TODO: more details needed, but I wanted to get this started
-
-* File system configuration
-
- While Archiva can be fully configred by the web interface, the configuration will be saved to the file system and can be edited from there if needed.
-
- Archiva's configuration is loaded from the following files, in order of most precedent:
-
- * <<<~/.m2/archiva.xml>>>
-
- * <<<$ARCHIVA_BASE/conf/archiva.xml>>>
-
- * <<<$ARCHIVA_HOME/conf/archiva.xml>>>
-
- When Archiva saves it's configuration, all configuration is stored to a single file. The file chosen is by the following rules:
-
- * If <<<~/.m2/archiva.xml>>> exists, it is saved there
-
- * Otherwise, it is saved to <<<$ARCHIVA_BASE/conf/archiva.xml>>>, regardless of whether it previously existed.
-
- The configuration will never be saved in <<<$ARCHIVA_HOME>>>.
-
- Note that the configuration can be edited, but only when Archiva is not running as it will not reload a changed configuration file, and will save over it
- if something is changed in the web interface.
-
-~~TODO: format?
-
diff --git a/archiva-site/src/site/apt/guides/getting-started.apt b/archiva-site/src/site/apt/guides/getting-started.apt
deleted file mode 100644
index f8d6c42b6..000000000
--- a/archiva-site/src/site/apt/guides/getting-started.apt
+++ /dev/null
@@ -1,120 +0,0 @@
- -----
- Getting Started with Archiva
- -----
- Henri Yandell
- -----
- 1 October 2006
- -----
-
-~~ 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/mini/guide-apt-format.html
-
-To deploy Archiva on Plexus
-
- Plexus is a container developed as a part of Maven. It provides a very simple way to get started with Archiva:
-
- * Unpack the archiva-plexus-runtime/target/archiva-bin.tar.gz archive into a directory of your choice.
-
- * Start with: ./bin/plexus.sh start or a platform specific version.
-
- * A Derby exception "Schema 'SA' does not exist" occurs, but is not of concern.
-
-To deploy Archiva on Tomcat 5.5
-
- * Create a directory in tomcat called archiva, at the same level as bin, conf, logs and the others.
-
- * Copy the war file from apps/archiva/lib into the new directory
-
- * Create a conf/Catalina/localhost/archiva.xml file with the following data:
-
-+-------------------------------------------------------------------------+
- <?xml version="1.0" encoding="UTF-8"?>
- <Context path="/archiva"
- docBase="${catalina.home}/archiva/archiva-webapp-1.0-SNAPSHOT.war">
-
- <Resource name="jdbc/users" auth="Container" type="javax.sql.DataSource"
- username="sa"
- password=""
- driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
- url="jdbc:derby:database/archiva;create=true" />
-
- <Resource name="jdbc/archiva" auth="Container" type="javax.sql.DataSource"
- username="sa"
- password=""
- driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
- url="jdbc:derby:database/archiva;create=true" />
-
- <Resource name="mail/Session" auth="Container"
- type="javax.mail.Session"
- mail.smtp.host="localhost"/>
- </Context>
-+-------------------------------------------------------------------------+
-
- * <<Note>>: Tomcat 5.5.20 and 5.5.23 are missing MailSessionFactory and a
- few other classes. JNDI mail sessions will <not> work. Use Tomcat 5.5.17
- instead, or see {{{http://issues.apache.org/bugzilla/show_bug.cgi?id=40668}
- Bug 40668}} for a workaround.
-
- * Copy $HOME/.m2/org/apache/derby/derby/10.1.3.1/derby-10.1.3.1.jar (or from the remote repository) into the Tomcat
- common/lib
-
- * To deal with a current bug, you'll also need to add the following to your ${catalina.home}/conf/web.xml in the
- relevant section (search for jspx):
-
-+-------------------------------------------------------------------------+
- <servlet-mapping>
- <servlet-name>jsp</servlet-name>
- <url-pattern>*.jspf</url-pattern>
- </servlet-mapping>
-+-------------------------------------------------------------------------+
-
- When you first start Archiva, you will see an Exception that schema SA does not exist - however it doesn't appear to
- cause a problem. If you use a username other than 'sa', such as 'archiva', then you seem to get the same error but
- Tomcat fails to start the context and you have to shutdown and restart again.
-
-Setting up your Archiva instance
-
- * Goto {{http://localhost:8080/archiva/}}
-
- * On the first page - setup your administration user. The password requires a numerical character and must not be
- longer than 8 chars. You'll then need to log in. User 'admin' as the username and the password you've entered.
-
- * On the second page - setup your first repository. It can be both an m1 and an m2 repository.
-
- * On the third page - setup your indexing. Mostly this means choosing a directory to put the index in. It'll
- re-index every hour.
-
-Updating Archiva within a Tomcat
-
- While exploring Archiva, or perhaps while developing with it, you will want to delete the
- current state. Presuming you followed the instructions above, you will need to remove the
- following files from the ${catalina.home} directory. Ensure your Tomcat has first been
- shutdown.
-
-+-------------------------------------------------------------------------+
- # Remove the database
- rm -r bin/database/ bin/derby.log
- # Remove the archiva configuration
- rm $HOME/.m2/archiva.xml
- # Remove the temporary Tomcat files
- rm webapps/archiva/ work/Catalina/localhost/archiva/ logs/*
- # Remove the war file (if you're deploying a new one)
- rm archiva/*.war
-+-------------------------------------------------------------------------+
diff --git a/archiva-site/src/site/apt/guides/maven-configuration.apt b/archiva-site/src/site/apt/guides/maven-configuration.apt
deleted file mode 100644
index 26fb1447a..000000000
--- a/archiva-site/src/site/apt/guides/maven-configuration.apt
+++ /dev/null
@@ -1,267 +0,0 @@
- -----
- Client Configuration
- -----
- -----
- 17 November 2006
- -----
-
-~~ 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/mini/guide-apt-format.html
-
-Configuring Maven-2 to use an Archiva repository
-
- 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 {{{http://maven.apache.org/settings.html}Settings Reference}}).
-
- You will need to add one entry for each repository that is setup in Archiva. If your repository contains plugins; remember to also include a <pluginRepository> setting.
-
- <URL-TO-ARCHIVA> => where to find Archiva eg. http://localhost:8080/archiva
-
- <REPOSITORY-ID> => Identifer for the proxied repository inside Archiva eg. internal, releases
-
- ~~ <URL-NAME> => Another identifier, this time for normal repositories [one of the these will go away]
-
-* Configuring a Repository
-
- [[1]] create a new profile to setup your repositories
-
-+-------------------------------------------------------------------------+
- <settings>
- ...
- <profiles>
- <profile>
- <id>Repository Proxy</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <!-- ******************************************************* -->
- <!-- repositories for jar artifacts -->
- <!-- ******************************************************* -->
- <repositories>
- <repository>
- ...
- </repository>
- ...
- </repositories>
- <!-- ******************************************************* -->
- <!-- repositories for maven plugins -->
- <!-- ******************************************************* -->
- <pluginRepositories>
- <pluginRepository>
- ...
- </pluginRepository>
- ...
- </pluginRepositories>
- </profile>
- ...
- </profiles>
- ...
- </settings>
-+-------------------------------------------------------------------------+
-
- [[2]] add your repository configuration to the profile...
-
- You can copy the repository configuration from the POM Snippet on the Archiva Administration Page for a normal repository. It should look much like:
-
-+-------------------------------------------------------------------------+
- <repository>
- <id>repository-1</id>
- <url>URL-TO-ARCHIVA/repository/REPOSITORY-ID</url>
- <releases>
- <enabled>true</enabled>
- </releases>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
- </repository>
-+-------------------------------------------------------------------------+
-
-* Configuring Maven-2 to deploy to an Archiva repository
-
- [[1]] Create a user in Archiva to use for deployment
-
- [[2]] The deployment user needs the Role 'Repository Manager' for each repository that you want to deploy to
-
- [[3]] Define the server for deployment inside your 'settings.xml', use the newly created user for authentication
-
-+-------------------------------------------------------------------------+
- <settings>
- ...
- <servers>
- <server>
- <id>deployment.webdav</id>
- <username>{archiva-deployment-user}</username>
- <password>{archiva-deployment-pwd}</password>
- </server>
- ...
- </servers>
- ...
- </settings>
-+-------------------------------------------------------------------------+
-
-* Deploying to Archiva
-
- [[1]] Configure the distributionManagement part of your pom.xml
-
-+-------------------------------------------------------------------------+
- <project>
- ...
- <distributionManagement>
- <repository>
- <id>deployment.webdav</id>
- <name>Internal Release Repository</name>
- <url>dav:URL-TO-ARCHIVA/repository/REPOSITORY-ID/</url>
- </repository>
- <snapshotRepository>
- <id>deployment.webdav</id>
- <name>Internal Snapshot Repository</name>
- <url>dav:URL-TO-ARCHIVA/repository/REPOSITORY-ID/</url>
- </snapshotRepository>
- </distributionManagement>
- ...
- </project>
-+-------------------------------------------------------------------------+
-
- [[2]] Add a build extension to your pom.xml to use webdav
-
-+-------------------------------------------------------------------------+
- <project>
- ...
- <build>
- <extensions>
- <extension>
- <groupId>org.apache.maven.wagon</groupId>
- <artifactId>wagon-webdav</artifactId>
- <version>1.0-beta-2</version>
- </extension>
- </extensions>
- </build>
- ...
- </project>
-+-------------------------------------------------------------------------+
-
- [[3]] Finally the user that is running archiva (tomcat-user, plexus-user,..) must have write access to the deployment repository.
-
-* Deploying Third-Party Artifacts to Archiva
-
- [[1]] In the directory from which you intend to execute "<<<mvn
- deploy:deploy-file>>>", save the following content as <<<pom.xml>>>.
-
-+-------+
-<project>
- <modelVersion>4.0.0</modelVersion>
- <groupId>com.example</groupId>
- <artifactId>webdav-deploy</artifactId>
- <packaging>pom</packaging>
- <version>1</version>
- <name>Webdav Deployment POM</name>
-
- <build>
- <extensions>
- <extension>
- <groupId>org.apache.maven.wagon</groupId>
- <artifactId>wagon-webdav</artifactId>
- <version>1.0-beta-2</version>
- </extension>
- </extensions>
- </build>
-
-</project>
-+-------+
-
- This pom will not be deployed with the artifact, it simply serves to make the
- wagon-webdav jar available to the build process.
-
- Alternately, save this file somewhere else, and use "<<<mvn ... -f
- /path/to/filename>>>" to force the use of an alternate POM file.
-
- [[2]] Deploy the artifact:
-
-+------+
-mvn deploy:deploy-file -Dfile=filename.jar -DpomFile=filename.pom
- -DrepositoryId=deployment.webdav
- -Durl=dav:URL-TO-ARCHIVA/repository/REPOSITORY-ID
-+------+
-
-Archiva as a Proxy
-
-* Creating a New Proxy Repository
-
- Archiva has pre-configured proxy connectors for the 'internal' managed repo and the 'central' and 'maven2-repository.dev.java.net' remote repositories.
-
- To create a new proxy repository, just do the following:
-
- [[1]] Add a new managed repository
-
- Go to Repositories --> Add (Managed Repository)
-
- Create the managed repository (let's say 'releases') which would serve as the proxy repo.
-
- Do not forget to set the necessary permissions or user roles in Users Management if you want this repository to be secured.
-
- [[2]] Add a remote repository
-
- Go to Repositories --> Add (Remote Repository)
-
- Add the remote repository you want to proxy.
-
- [[3]] Create a proxy connector
-
- Go to Proxy Connectors --> Add
-
- Fill up the following fields:
-
- * Network Proxy* - if your network connection has a network proxy, then this should be configured via the Network Proxies in Archiva. Select the network proxy, if you're using one, that will be used for this proxy connector.
-
- * Managed Repository* - the managed repository you want to connect to the remote repository.
-
- * Remote Repository* - the repository you want to proxy
-
- * Policies - the download policies that will be used by Archiva when proxying
-
- * Properties
-
- * Black List Patterns - the patterns that will be blacklisted during proxying
-
- * White List Patterns - the patterns that will be included during proxying
-
-* Using the Proxy Repository with Maven
-
- Set-up your settings.xml file as shown above in sections 1 and 2 of Configuring a Repository. In this case, use the repository configuration of the managed repository you've created.
-
- Then, configure the <server> settings in the settings.xml file as shown below:
-
-+-------------------------------------------------------------------------+
- <settings>
- ...
- <servers>
- <server>
- <id>releases</id>
- <username>{archiva-user}</username>
- <password>{archiva-pwd}</password>
- </server>
- ...
- </servers>
- ...
- </settings>
-+-------------------------------------------------------------------------+
-
- Execute a Maven 2 build. Artifacts should be downloaded from the proxy repository/repositories you've set in your settings.xml
-
- \ No newline at end of file
diff --git a/archiva-site/src/site/apt/guides/security-configuration.apt b/archiva-site/src/site/apt/guides/security-configuration.apt
deleted file mode 100644
index 2263cb409..000000000
--- a/archiva-site/src/site/apt/guides/security-configuration.apt
+++ /dev/null
@@ -1,126 +0,0 @@
- ------
- Archiva Security Configuration
- ------
- The Maven Team
- ------
- 17 February 2007
- ------
-
-~~ 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/mini/guide-apt-format.html
-
-Archiva Security Configuration
-
-* Properties
-
- Archiva makes use of Redback to handle user ids, passwords and roles.
-
- Security properties and password rules can be configured in the
- <<<security.properties>>> file, which by default is searched for in:
-
- * <<<~/.m2/security.properties>>>
-
- * <<<$ARCHIVA_HOME/conf/security.properties>>>
-
- []
-
- (In the above list, <<<~>>> is the home directory of the user who is running
- Archiva, and <<<$ARCHIVA_HOME>>> is the directory where Archiva is installed,
- such as <<</opt/archiva-1.0-SNAPSHOT>>>.)
-
-~~ TODO: Link to plexus-redback documentation when available
-
- Following are some of the properties you can modify. For a complete list,
- consult the default properties file in Redback's svn repo:
- {{{http://svn.codehaus.org/redback/redback/trunk/redback-configuration/src/main/resources/org/codehaus/plexus/redback/config-defaults.properties}
- config-defaults.properties}}
-
-+-----+
-# Security Policies
-#security.policy.password.encoder=
-security.policy.password.previous.count=6
-security.policy.password.expiration.days=90
-security.policy.allowed.login.attempt=3
-
-# Password Rules
-security.policy.password.rule.alphanumeric.enabled=false
-security.policy.password.rule.alphacount.enabled=true
-security.policy.password.rule.alphacount.minimum=1
-security.policy.password.rule.characterlength.enabled=true
-security.policy.password.rule.characterlength.minimum=1
-security.policy.password.rule.characterlength.maximum=8
-security.policy.password.rule.musthave.enabled=true
-security.policy.password.rule.numericalcount.enabled=true
-security.policy.password.rule.numericalcount.minimum=1
-security.policy.password.rule.reuse.enabled=true
-security.policy.password.rule.nowhitespace.enabled=true
-+-----+
-
- <<Note:>> Archiva's list of configuration files is <itself> configurable, and
- can be found in:
- <<<$ARCHIVA_HOME/apps/archiva/webapp/WEB-INF/classes/META-INF/plexus/application.xml>>>
-
-* Database
-
- By default, Archiva uses embedded {{{http://db.apache.org/derby}Apache Derby}}
- to store the user information. It can be configured to use an external database
- by providing a JDBC driver and editing the <<<plexus.xml>>> file.
-
- [[1]] Place the jar containing the JDBC driver in <<<$ARCHIVA_HOME/core>>>.
-
- [[2]] Edit <<<$ARCHIVA_HOME/conf/plexus.xml>>>, providing the JDBC driver class
- name, and the database url, username, and password.
-
- []
-
- For example:
-
-+------+
-<!--
- Datasources
--->
-<resource>
- <name>jdbc/users</name>
- <type>javax.sql.DataSource</type>
- <properties>
- <property>
- <name>driverClassName</name>
- <value>org.apache.derby.jdbc.ClientDriver</value>
- </property>
- <property>
- <name>url</name>
- <value>jdbc:derby://localhost:1527/archiva-users;create=true</value>
- </property>
- <property>
- <name>username</name>
- <value>user1</value>
- </property>
- <property>
- <name>password</name>
- <value>user1</value>
- </property>
- </properties>
-</resource>
-+------+
-
- More information about using Derby Network Server as an external user database
- for Archiva can be found on the wiki:
- {{{http://docs.codehaus.org/display/MAVENUSER/Archiva+User+DB+on+Derby+Network+Server}
- Archiva User DB on Derby Network Server}}
diff --git a/archiva-site/src/site/apt/index.apt b/archiva-site/src/site/apt/index.apt
deleted file mode 100644
index d5fbd1f7e..000000000
--- a/archiva-site/src/site/apt/index.apt
+++ /dev/null
@@ -1,25 +0,0 @@
- -----
- Welcome to Maven Archiva
- -----
- -----
- -----
-
- Archiva is a build artifact repository manager for use with
- build tools such as {{{http://maven.apache.org} Maven}}, {{{http://maven.apache.org/continuum/} Continuum}}, and {{{http://ant.apache.org/} ANT}}.
-
- With Archiva, you can share artifacts with other developers and manage the associated
- security required, aggregate (proxy) content from remote artifact repositories, visualise
- your artifact utilisation with search, browse and reporting, and perform routine
- maintenance on your repositories.
-
- ~~TODO: improve appearance of links
-
- To get started with Archiva, read the following documentation:
-
- * {{{/quick-start.html} A Quick Getting Started Guide}}
-
- * {{{/userguide/index.html} User's Guide}}
-
- * {{{/adminguide/index.html} Administrator's Guide}}
-
- []
diff --git a/archiva-site/src/site/apt/quick-start.apt b/archiva-site/src/site/apt/quick-start.apt
deleted file mode 100644
index c50b40b29..000000000
--- a/archiva-site/src/site/apt/quick-start.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Quick Start
- ------
-
-Quick Start
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/userguide/browsing.apt b/archiva-site/src/site/apt/userguide/browsing.apt
deleted file mode 100644
index e73c11d6d..000000000
--- a/archiva-site/src/site/apt/userguide/browsing.apt
+++ /dev/null
@@ -1,70 +0,0 @@
- ------
- Browsing
- ------
- Maria Odea Ching
- ------
- 9 November 2007
- ------
-
-~~ 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/mini/guide-apt-format.html
-
-
-Browsing
-
-* Permissions
-
- The user can only browse those repositories where the user is an observer or a manager. If the user does not
- have permission to access any repository, a message saying "You have access to no repositories. Ask your
- system administrator for access" will be displayed.
-
-* Repository Browse Layout
-
- The current layout of the repositories in Repository Browse uses the Maven 2 layout, which is the groupId,
- artifactId and version. When the version is clicked, the Artifact Info page (see the next section) will be
- displayed. There is currently an issue with regard to Maven 1 artifacts, see {{{http://jira.codehaus.org/browse/MRM-585} http://jira.codehaus.org/browse/MRM-585}}.
-
-* Artifact Info
-
- The Artifact Info page is divided into 5 views:
-
- 1. Info. Basic information about the artifact is displayed here. These are the groupId, artifactId, version and
- packaging. A dependency pom snippet is also available, which a user can just copy and paste in a pom file
- to declare the artifact as a dependency of the project.
-
- 2. Dependencies. The dependencies of the artifact will be listed here. The user can easily navigate to a specific
- dependency by clicking on the groupId, artifactId or version link. The scope of the dependency is also shown.
-
- 3. Dependency Tree. The dependencies of the artifact are displayed in a tree-like view, which can also be
- navigated.
-
- 4. Used By. Lists all the artifacts in the repository which use this artifact.
-
- 5. Mailing Lists. The project mailing lists available in the artifact's pom are displayed here.
-
-* Downloading Artifacts
-
- Artifacts can be downloaded from the artifact info page. All files, except for the metadata.xml files, that are
- associated with the artifact are available in the download box. The size of the files in bytes are displayed
- at the right section of the download box.
-
-
-
- \ No newline at end of file
diff --git a/archiva-site/src/site/apt/userguide/deploy.apt b/archiva-site/src/site/apt/userguide/deploy.apt
deleted file mode 100644
index 30fbbdb48..000000000
--- a/archiva-site/src/site/apt/userguide/deploy.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Deploying to Repository
- ------
-
-Deploying to Repository
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/userguide/find-artifact.apt b/archiva-site/src/site/apt/userguide/find-artifact.apt
deleted file mode 100644
index 132636716..000000000
--- a/archiva-site/src/site/apt/userguide/find-artifact.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Identifying an Artifact
- ------
-
-Identifying an Artifact
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/userguide/index.apt b/archiva-site/src/site/apt/userguide/index.apt
deleted file mode 100644
index 58ef923d2..000000000
--- a/archiva-site/src/site/apt/userguide/index.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- User Guide
- ------
-
-User Guide
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/userguide/searching.apt b/archiva-site/src/site/apt/userguide/searching.apt
deleted file mode 100644
index dd1cf04ed..000000000
--- a/archiva-site/src/site/apt/userguide/searching.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Searching
- ------
-
-Searching
-
- :STUB: This is a documentation stub.
-
diff --git a/archiva-site/src/site/apt/userguide/using-repository.apt b/archiva-site/src/site/apt/userguide/using-repository.apt
deleted file mode 100644
index 0fff28b49..000000000
--- a/archiva-site/src/site/apt/userguide/using-repository.apt
+++ /dev/null
@@ -1,8 +0,0 @@
- ------
- Using as a Repository
- ------
-
-Using as a Repository
-
- :STUB: This is a documentation stub.
-