From e162e0a8db5a97a24566b14cad5e9e6aaed70a44 Mon Sep 17 00:00:00 2001 From: Martin Stockhammer Date: Tue, 21 Mar 2017 21:26:51 +0100 Subject: [PATCH] Adding additional documentation --- archiva-docs/src/site/apt/adminguide/webapp.apt | 6 +++--- .../src/site/apt/adminguide/webservices/rest.apt.vm | 13 ++++++++++--- .../site/apt/customising/writing-consumer.apt.vm | 2 +- archiva-docs/src/site/apt/release-notes.apt.vm | 4 +++- 4 files changed, 17 insertions(+), 8 deletions(-) diff --git a/archiva-docs/src/site/apt/adminguide/webapp.apt b/archiva-docs/src/site/apt/adminguide/webapp.apt index e035e37d3..91cec16f3 100644 --- a/archiva-docs/src/site/apt/adminguide/webapp.apt +++ b/archiva-docs/src/site/apt/adminguide/webapp.apt @@ -25,10 +25,10 @@ Installing Apache Archiva as a Web Application -~~TODO: link to wiki location for other application servers - Archiva can be deployed as a web application into any Java EE application server. This document will show an - example of doing so with Apache Tomcat 5.5, 6.0.x and 7.0.x + example of doing so with Apache Tomcat 5.5, 6.0.x and 7.0.x. + + You can find information about additional application servers on {{{https://cwiki.apache.org/confluence/display/ARCHIVA/HOWTO+run+Archiva+on+your+Application+Server+or+Database} the archiva wiki}}. <>: When you first start Archiva, you will see an Exception that schema SA does not exist - however it doesn't cause a problem. If you use a username other than 'sa', such as 'archiva', then you seem to get the same error but diff --git a/archiva-docs/src/site/apt/adminguide/webservices/rest.apt.vm b/archiva-docs/src/site/apt/adminguide/webservices/rest.apt.vm index 874c3eaf2..0aedc6d49 100644 --- a/archiva-docs/src/site/apt/adminguide/webservices/rest.apt.vm +++ b/archiva-docs/src/site/apt/adminguide/webservices/rest.apt.vm @@ -38,6 +38,13 @@ Using REST Services * Redback REST api is available here: {{http://archiva.apache.org/docs/${project.version}/rest-docs-redback-rest-api/index.html}} +* Security related information + + Starting with version 2.2.2 we added HTTP verification techniques to avoid cross site request forgery attacks. The + updating services check Origin and Referer header and use a token provided by the login service. + If you use the webservices with a native client that is no browser or want to allow requests from different origin + URLs you have to change the configuration. For further information see the {{{/redback/integration/rest.html}Redback REST documentation}} + * Search Service Authentication headers for connect to your Archiva instance : @@ -114,11 +121,11 @@ Using REST Services Current versions use in Apache Archiva: - * $\{project.version}: ${project.version} + * <<<$\{project.version}>>>: ${project.version} - * $\{cxfVersion}: ${cxfVersion} + * <<<$\{cxfVersion}>>>: ${cxf.version} - * $\{jacksonVersion}: ${jacksonVersion} + * <<<$\{jacksonVersion}>>>: ${jacksonVersion} * Security Framework Services: diff --git a/archiva-docs/src/site/apt/customising/writing-consumer.apt.vm b/archiva-docs/src/site/apt/customising/writing-consumer.apt.vm index c7eee9ca3..32ebce67d 100644 --- a/archiva-docs/src/site/apt/customising/writing-consumer.apt.vm +++ b/archiva-docs/src/site/apt/customising/writing-consumer.apt.vm @@ -30,7 +30,7 @@ Writing a Consumer Plugin For a sample custom consumer, you can checkout the archiva-consumer-plugin at the archiva sandbox in the SVN repository: - Prior to release 1.4, plexus components are not anymore supported, you must use Spring components. + Starting with release 1.4, plexus components are not anymore supported, you must use Spring components. * Writing manually diff --git a/archiva-docs/src/site/apt/release-notes.apt.vm b/archiva-docs/src/site/apt/release-notes.apt.vm index c5fe219ec..6eecfd012 100644 --- a/archiva-docs/src/site/apt/release-notes.apt.vm +++ b/archiva-docs/src/site/apt/release-notes.apt.vm @@ -38,8 +38,9 @@ Release Notes for Archiva ${project.version} Apache Archiva ${project.version} is a bugs fix release: - * There are added some fixes to avoid requests from unknown origin + * Some fixes were added to avoid requests from unknown origin + * Some minor bugfixes were added * Compatibility Changes @@ -51,6 +52,7 @@ Release Notes for Archiva ${project.version} For more information see {{{./adminguide/customising-security.html}Archiva Security Configuration}} and the {{{/redback/integration/rest.html}Redback REST documentation }} + * Archiva uses redback for authentication and authorization in version ${redback.version} * Release Notes -- 2.39.5