diff options
author | Brett Porter <brett@apache.org> | 2007-11-23 03:57:20 +0000 |
---|---|---|
committer | Brett Porter <brett@apache.org> | 2007-11-23 03:57:20 +0000 |
commit | de98da31bde24f84f57d117740b66aa1c7a662f5 (patch) | |
tree | 64a4c5d1f2ae33cf45cbaeef7c372515bc8ddb64 /archiva-docs | |
parent | 59f1163fbddee1440e6a85538c085eb122b24faa (diff) | |
download | archiva-de98da31bde24f84f57d117740b66aa1c7a662f5.tar.gz archiva-de98da31bde24f84f57d117740b66aa1c7a662f5.zip |
move the security configuration
git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@597537 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'archiva-docs')
-rw-r--r-- | archiva-docs/src/site/apt/adminguide/customising-security.apt | 51 | ||||
-rw-r--r-- | archiva-docs/src/site/apt/adminguide/security.apt | 2 | ||||
-rw-r--r-- | archiva-docs/src/site/apt/adminguide/standalone.apt | 48 | ||||
-rw-r--r-- | archiva-docs/src/site/apt/guides/security-configuration.apt | 126 | ||||
-rw-r--r-- | archiva-docs/src/site/site.xml | 2 |
5 files changed, 102 insertions, 127 deletions
diff --git a/archiva-docs/src/site/apt/adminguide/customising-security.apt b/archiva-docs/src/site/apt/adminguide/customising-security.apt new file mode 100644 index 000000000..a1db44889 --- /dev/null +++ b/archiva-docs/src/site/apt/adminguide/customising-security.apt @@ -0,0 +1,51 @@ + ----- + Archiva Security Configuration + ----- + +Archiva Security Configuration + + 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:>> If installed standalone, 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>>> + diff --git a/archiva-docs/src/site/apt/adminguide/security.apt b/archiva-docs/src/site/apt/adminguide/security.apt index 16a746a31..043a22239 100644 --- a/archiva-docs/src/site/apt/adminguide/security.apt +++ b/archiva-docs/src/site/apt/adminguide/security.apt @@ -9,6 +9,8 @@ Understanding Apache Archiva Security * {{{roles.html} Roles in Archiva}} + * {{{customising-security.html} Customising Security}} + [] ~~TODO: LDAP diff --git a/archiva-docs/src/site/apt/adminguide/standalone.apt b/archiva-docs/src/site/apt/adminguide/standalone.apt index 34226c781..7160a95c1 100644 --- a/archiva-docs/src/site/apt/adminguide/standalone.apt +++ b/archiva-docs/src/site/apt/adminguide/standalone.apt @@ -29,6 +29,54 @@ Installing Standalone Distribution of Apache Archiva 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. +* 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}} + {Upgrading Archiva} diff --git a/archiva-docs/src/site/apt/guides/security-configuration.apt b/archiva-docs/src/site/apt/guides/security-configuration.apt deleted file mode 100644 index 2263cb409..000000000 --- a/archiva-docs/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-docs/src/site/site.xml b/archiva-docs/src/site/site.xml index 95f56392f..080f81a22 100644 --- a/archiva-docs/src/site/site.xml +++ b/archiva-docs/src/site/site.xml @@ -52,6 +52,7 @@ <item name="Databases" href="/adminguide/databases.html" /> <item name="Security" href="/adminguide/security.html" collapse="true"> <item name="Roles" href="/adminguide/roles.html" /> + <item name="Customising" href="/adminguide/customising-security.html" /> <!-- TODO: for a future version <item name="Using LDAP" href="/adminguide/ldap.html" /> --> @@ -74,7 +75,6 @@ <menu name="Old Menu (deprecated)"> <item name="FAQ" href="http://docs.codehaus.org/display/MAVENUSER/Archiva+FAQ"/> <item name="Maven Configuration" href="/guides/maven-configuration.html"/> - <item name="Security Configuration" href="/guides/security-configuration.html"/> <item name="Hacking Archiva" href="/hacking/index.html"/> </menu> </body> |