Author: olamy
Date: Thu Sep 27 15:53:20 2012
New Revision: 1391065
URL: http://svn.apache.org/viewvc?rev=1391065&view=rev
Log:
Apache Archiva Versionned docs for 1.4-M3-SNAPSHOT
Added:
archiva/site-content/docs/1.4-M3-SNAPSHOT/images/role-detail.png (with
props)
archiva/site-content/docs/1.4-M3-SNAPSHOT/images/role-users.png (with
props)
archiva/site-content/docs/1.4-M3-SNAPSHOT/images/roles-list.png (with
props)
Modified:
archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/roles.html
archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/standalone.html
Modified: archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/roles.html
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/roles.html?rev=1391065&r1=1391064&r2=1391065&view=diff
==============================================================================
--- archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/roles.html (original)
+++ archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/roles.html Thu Sep 27
15:53:20 2012
@@ -328,7 +328,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>Understanding Apache Archiva Security Roles<a
name="Understanding_Apach
e_Archiva_Security_Roles"></a></h2><p>Archiva uses the <a class="externalLink"
href="http://archiva.apache.org/redback/";> Redback</a> security framework for
managing repository security. When the server is first started, you will be
prompted to create an administration user. This user will be given permission
to administer all aspects of the system (as well as access to all of the
repositories). This user can then be used to grant permissions to other
users.</p><p>A guest user is also created by default, and given read access to
the default repositories (<tt>internal</tt> and <tt>snapshots</tt>).
Repositories with guest user access can be accessed without the use of a
username and password (or without being logged in to the web
interface).</p><p>However, when new repositories are created, by default no
permissions are assigned and only the administrators will have access until it
is explicitly granted.</p><p>Note that Redback has the concept of inferred
roles, so the assignm
ent of some roles will imply other roles (which will be displayed in the web
interface).</p><div class="section"><h3>Repository Roles<a
name="Repository_Roles"></a></h3><p>Archiva contains the following roles for
repository access:</p><ul><li><i>Repository Observer</i>: users with this role
can read from the given repository that the role is for (including access
through the browse and search features of the web
interface)</li><li><i>Repository Manager</i>: users with this role can write to
and administer the given repository that the role is for</li><li><i>Global
Repository Observer</i>: users with this role can read from any repository
(including access through the browse and search features of the web
interface)</li><li><i>Global Repository Manager</i>: users with this role can
write to and administer any repository in the instance</li></ul></div><div
class="section"><h3>General Roles<a name="General_Roles"></a></h3><p>Archiva
also contains the following general roles for
security of the instance:</p><ul><li><i>System Administrator</i>: full access
to all functionality in the system</li><li><i>User Administrator</i>: ability
to create, edit, and grant roles to other users in the system</li></ul><p>The
guest and registered user roles do not affect repository access.</p><!-- TODO:
walkthrough screens --></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. --><div
class="section"><h2>Understanding Apache Archiva Security Roles<a
name="Understanding_Apach
e_Archiva_Security_Roles"></a></h2><p>Archiva uses the <a class="externalLink"
href="http://archiva.apache.org/redback/";> Redback</a> security framework for
managing repository security. When the server is first started, you will be
prompted to create an administration user. This user will be given permission
to administer all aspects of the system (as well as access to all of the
repositories). This user can then be used to grant permissions to other
users.</p><p>A guest user is also created by default, and given read access to
the default repositories (<tt>internal</tt> and <tt>snapshots</tt>).
Repositories with guest user access can be accessed without the use of a
username and password (or without being logged in to the web
interface).</p><p>However, when new repositories are created, by default no
permissions are assigned and only the administrators will have access until it
is explicitly granted.</p><p>Note that Redback has the concept of inferred
roles, so the assignm
ent of some roles will imply other roles (which will be displayed in the web
interface).</p><div class="section"><h3>Repository Roles<a
name="Repository_Roles"></a></h3><p>Archiva contains the following roles for
repository access:</p><ul><li><i>Repository Observer</i>: users with this role
can read from the given repository that the role is for (including access
through the browse and search features of the web
interface)</li><li><i>Repository Manager</i>: users with this role can write to
and administer the given repository that the role is for</li><li><i>Global
Repository Observer</i>: users with this role can read from any repository
(including access through the browse and search features of the web
interface)</li><li><i>Global Repository Manager</i>: users with this role can
write to and administer any repository in the instance</li></ul><div
class="section"><h4>Roles list<a name="Roles_list"></a></h4><img
src="../images/roles-list.png" alt="" /></div><div class="secti
on"><h4>Role details<a name="Role_details"></a></h4><img
src="../images/role-detail.png" alt="" /></div><div class="section"><h4>Attach
users to a role<a name="Attach_users_to_a_role"></a></h4><img
src="../images/role-users.png" alt="" /></div></div><div
class="section"><h3>General Roles<a name="General_Roles"></a></h3><p>Archiva
also contains the following general roles for security of the
instance:</p><ul><li><i>System Administrator</i>: full access to all
functionality in the system</li><li><i>User Administrator</i>: ability to
create, edit, and grant roles to other users in the system</li></ul><p>The
guest and registered user roles do not affect repository access.</p><!-- TODO:
walkthrough screens --></div></div>
</div>
</div>
</div>
Modified: archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/standalone.html
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/standalone.html?rev=1391065&r1=1391064&r2=1391065&view=diff
==============================================================================
--- archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/standalone.html
(original)
+++ archiva/site-content/docs/1.4-M3-SNAPSHOT/adminguide/standalone.html Thu
Sep 27 15:53:20 2012
@@ -337,7 +337,16 @@ 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>Installing Standalone Distribution of Apache Archiva<a
name="Installing
_Standalone_Distribution_of_Apache_Archiva"></a></h2><p>Installing the
standalone distribution of Archiva is quite simple - for an example, see the <a
href="../quick-start.html"> Quick Start</a> guide.</p><p>However, the best way
to use this installation technique is to separate the configuration from the
installation to make it easy to upgrade to newer versions in the
future.</p><div class="section"><h3>Running Archiva<a
name="Running_Archiva"></a></h3><p>Archiva can be run by
executing:</p><ul><li><tt>bin/archiva</tt>, or <tt>bin\archiva.bat</tt> for
Windows (select the one for your environment). The argument can be
<tt>console</tt> to run interactively, or <tt>start</tt> to run in the
background (in this case, run the script with <tt>stop</tt> to later stop the
server). The logs are available in the <tt>logs</tt> directory where Archiva is
installed.</li></ul><p>There is an issue with regard to the version of
<tt>tr</tt> installed/used by default on Solaris so you might e
ncounter a series of <tt>Bad String</tt> errors when you run the Archiva
binaries in Solaris. You need to use a different version of <tt>tr</tt> in
order to get it to work. See <a class="externalLink"
href="http://jira.codehaus.org/browse/MRM-1467";> MRM-1467</a> for more
details.</p></div><div class="section"><h3>Installing as a Service on Windows<a
name="Installing_as_a_Service_on_Windows"></a></h3><p>On Windows, to use the
<tt>start</tt> and <tt>stop</tt> commands you must first install it as a
service. This is done by running:</p><div><pre>.\bin\archiva.bat
install</pre></div><p>You can then use the <tt>start</tt> and <tt>stop</tt>
commands as well as the traditional Windows service management console to
manage the Archiva service.</p><p>This procedure installs the service to run as
the local system user. You must ensure that it has access to read the
installation, and to write to the logs and data directories.</p><p>You can
later remove the service with:</p><div><pre>.\b
in\archiva.bat remove</pre></div></div><div class="section"><h3>Separating the
base from the installation<a
name="Separating_the_base_from_the_installation"></a></h3><p>The standalone
installation of Archiva is capable of separating its configuration from
installation in much the same way Tomcat does.</p><p>This is achieved by the
following steps:</p><ol style="list-style-type: decimal"><li>Create the base
location. For example, you might install Archiva in <tt>/opt/archiva-1.4</tt>
and the data in <tt>/var/archiva</tt>. Create the directories
<tt>/var/archiva/logs</tt>, <tt>/var/archiva/data</tt>,
<tt>/var/archiva/temp</tt> and <tt>/var/archiva/conf</tt>.</li><li>Move the
configuration files from the Archiva installation (e.g.
<tt>/opt/archiva-1.4/conf</tt> to the new location (e.g.
<tt>/var/archiva/conf</tt>). If you've previously run Archiva, you may need to
edit <tt>conf/archiva.xml</tt> to change the location of the
repositories.</li><li>(Optionally, leave a README file
in the old conf location as a reminder of where you moved the config
files.)</li><li>Set the environment variable <tt>ARCHIVA_BASE</tt> to the new
location (e.g. <tt>/var/archiva</tt>). In bash, be sure to export the
variable.</li><li>Start Archiva standalone as described above from the
installation location</li></ol></div><div class="section"><h3>Configuring
Archiva<a name="Configuring_Archiva"></a></h3><p>Archiva's configuration is
loaded from the following files, in order of
precedence:</p><ul><li><tt>~/.m2/archiva.xml</tt></li><li><tt>$ARCHIVA_BASE/conf/archiva.xml</tt></li><li><tt>conf/archiva.xml</tt>
in the Archiva installation</li></ul><p>When Archiva saves its configuration,
all configuration is stored in a single file. The file chosen is by the
following rules:</p><ul><li>If <tt>~/.m2/archiva.xml</tt> exists, it is saved
there</li><li>Otherwise, if <tt>$ARCHIVA_BASE/conf/archiva.xml</tt> exists, it
is saved there</li><li>If neither apply, it is saved to <tt>~/.m2/
archiva.xml</tt>.</li></ul><p>The configuration will never be saved in the
Archiva installation directory if you are using a separate base
directory.</p><p>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.</p></div><div
class="section"><h3>Database<a name="Database"></a></h3><p>By default, Archiva
uses embedded <a class="externalLink" href="http://db.apache.org/derby";>Apache
Derby</a> to store the user information. It can be configured to use an
external database by providing a JDBC driver and editing the <tt>jetty.xml</tt>
file.</p><ol style="list-style-type: decimal"><li>Place the jar containing the
JDBC driver in the <tt>lib</tt> directory of the Archiva
installation.</li><li>Edit <tt>conf/jetty.xml</tt>, providing the JDBC driver
class name, database url, username, and password.</li></ol><p>The example below
uses Mysql for
the database server. You can take a look at <a class="externalLink"
href="http://cwiki.apache.org/confluence/display/ARCHIVA/Archiva+with+MySQL";>Archiva
with MySQL</a> for more details.</p><div class="source"><pre
class="prettyprint"> <!-- omitted xml -->
+ <!-- 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>Installing Standalone Distribution of Apache Archiva<a
name="Installing
_Standalone_Distribution_of_Apache_Archiva"></a></h2><p>Installing the
standalone distribution of Archiva is quite simple - for an example, see the <a
href="../quick-start.html"> Quick Start</a> guide.</p><p>However, the best way
to use this installation technique is to separate the configuration from the
installation to make it easy to upgrade to newer versions in the
future.</p><div class="section"><h3>Running Archiva<a
name="Running_Archiva"></a></h3><p>Archiva can be run by
executing:</p><ul><li><tt>bin/archiva</tt>, or <tt>bin\archiva.bat</tt> for
Windows (select the one for your environment). The argument can be
<tt>console</tt> to run interactively, or <tt>start</tt> to run in the
background (in this case, run the script with <tt>stop</tt> to later stop the
server). The logs are available in the <tt>logs</tt> directory where Archiva is
installed.</li></ul><p>There is an issue with regard to the version of
<tt>tr</tt> installed/used by default on Solaris so you might e
ncounter a series of <tt>Bad String</tt> errors when you run the Archiva
binaries in Solaris. You need to use a different version of <tt>tr</tt> in
order to get it to work. See <a class="externalLink"
href="http://jira.codehaus.org/browse/MRM-1467";> MRM-1467</a> for more
details.</p><p><b>NOTE</b>: since 1.4-M3 Archiva is now available on / (ROOT)
context.</p><p>If you want to use an other context path, you must edit the file
in contexts/archiva.xml</p><div class="source"><pre
class="prettyprint"><Configure
class="org.eclipse.jetty.webapp.WebAppContext">
+
+ <!-- contextPath used -->
+ <Set name="contextPath">/</Set>
+ <Set name="war"><SystemProperty
name="jetty.home" default="."/>/apps/archiva</Set>
+
+ <Set name="extractWAR">false</Set>
+ <Set name="copyWebDir">false</Set>
+
+</Configure></pre></div></div><div class="section"><h3>Installing as a
Service on Windows<a name="Installing_as_a_Service_on_Windows"></a></h3><p>On
Windows, to use the <tt>start</tt> and <tt>stop</tt> commands you must first
install it as a service. This is done by
running:</p><div><pre>.\bin\archiva.bat install</pre></div><p>You can then use
the <tt>start</tt> and <tt>stop</tt> commands as well as the traditional
Windows service management console to manage the Archiva service.</p><p>This
procedure installs the service to run as the local system user. You must ensure
that it has access to read the installation, and to write to the logs and data
directories.</p><p>You can later remove the service
with:</p><div><pre>.\bin\archiva.bat remove</pre></div></div><div
class="section"><h3>Separating the base from the installation<a
name="Separating_the_base_from_the_installation"></a></h3><p>The standalone
installation of Archiva is capable of separating its configuration fro
m installation in much the same way Tomcat does.</p><p>This is achieved by the
following steps:</p><ol style="list-style-type: decimal"><li>Create the base
location. For example, you might install Archiva in <tt>/opt/archiva-1.4</tt>
and the data in <tt>/var/archiva</tt>. Create the directories
<tt>/var/archiva/logs</tt>, <tt>/var/archiva/data</tt>,
<tt>/var/archiva/temp</tt> and <tt>/var/archiva/conf</tt>.</li><li>Move the
configuration files from the Archiva installation (e.g.
<tt>/opt/archiva-1.4/conf</tt> to the new location (e.g.
<tt>/var/archiva/conf</tt>). If you've previously run Archiva, you may need to
edit <tt>conf/archiva.xml</tt> to change the location of the
repositories.</li><li>(Optionally, leave a README file in the old conf location
as a reminder of where you moved the config files.)</li><li>Set the environment
variable <tt>ARCHIVA_BASE</tt> to the new location (e.g.
<tt>/var/archiva</tt>). In bash, be sure to export the variable.</li><li>Start
Archiva stan
dalone as described above from the installation location</li></ol></div><div
class="section"><h3>Configuring Archiva<a
name="Configuring_Archiva"></a></h3><p>Archiva's configuration is loaded from
the following files, in order of
precedence:</p><ul><li><tt>~/.m2/archiva.xml</tt></li><li><tt>$ARCHIVA_BASE/conf/archiva.xml</tt></li><li><tt>conf/archiva.xml</tt>
in the Archiva installation</li></ul><p>When Archiva saves its configuration,
all configuration is stored in a single file. The file chosen is by the
following rules:</p><ul><li>If <tt>~/.m2/archiva.xml</tt> exists, it is saved
there</li><li>Otherwise, if <tt>$ARCHIVA_BASE/conf/archiva.xml</tt> exists, it
is saved there</li><li>If neither apply, it is saved to
<tt>~/.m2/archiva.xml</tt>.</li></ul><p>The configuration will never be saved
in the Archiva installation directory if you are using a separate base
directory.</p><p>Note that the configuration can be edited, but only when
Archiva is not running as it will not rel
oad a changed configuration file, and will save over it if something is
changed in the web interface.</p></div><div class="section"><h3>Database<a
name="Database"></a></h3><p>By default, Archiva uses embedded <a
class="externalLink" href="http://db.apache.org/derby";>Apache Derby</a> to
store the user information. It can be configured to use an external database by
providing a JDBC driver and editing the <tt>jetty.xml</tt> file.</p><ol
style="list-style-type: decimal"><li>Place the jar containing the JDBC driver
in the <tt>lib</tt> directory of the Archiva installation.</li><li>Edit
<tt>conf/jetty.xml</tt>, providing the JDBC driver class name, database url,
username, and password.</li></ol><p>The example below uses Mysql for the
database server. You can take a look at <a class="externalLink"
href="http://cwiki.apache.org/confluence/display/ARCHIVA/Archiva+with+MySQL";>Archiva
with MySQL</a> for more details.</p><div class="source"><pre
class="prettyprint"> <!-- omitted xm
l -->
<!-- Users / Security Database -->
Added: archiva/site-content/docs/1.4-M3-SNAPSHOT/images/role-detail.png
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/images/role-detail.png?rev=1391065&view=auto
==============================================================================
Binary file - no diff available.
Propchange: archiva/site-content/docs/1.4-M3-SNAPSHOT/images/role-detail.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: archiva/site-content/docs/1.4-M3-SNAPSHOT/images/role-users.png
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/images/role-users.png?rev=1391065&view=auto
==============================================================================
Binary file - no diff available.
Propchange: archiva/site-content/docs/1.4-M3-SNAPSHOT/images/role-users.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: archiva/site-content/docs/1.4-M3-SNAPSHOT/images/roles-list.png
URL:
http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M3-SNAPSHOT/images/roles-list.png?rev=1391065&view=auto
==============================================================================
Binary file - no diff available.
Propchange: archiva/site-content/docs/1.4-M3-SNAPSHOT/images/roles-list.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
