diff --git a/maven-site/src/site/xdoc/configuration.xml b/maven-site/src/site/xdoc/configuration.xml index 5553baacfc..6b5bdbdcd3 100644 --- a/maven-site/src/site/xdoc/configuration.xml +++ b/maven-site/src/site/xdoc/configuration.xml @@ -6,8 +6,123 @@

- ... + Maven configuration occurs at 3 levels:

+ +

+ The separation is quite clear - the project defines information that applies to the project, no matter who is + building it, while the others both define settings for the current environment. +

+

+ Note: the installation and user configuration can not be used to add shared project information - + for example setting + <organization> or + <distributionManagement> company-wide. + For this, you should have your projects inherit from a company-wide parent + pom.xml. + +

+

+ User configuration is specified in + ${user.home}/.m2/settings.xml. A + full reference to the + configuration file is available. This section will show how to make some common configurations. +

+

+ Configuring your Local Repository +

+

+ The local repository is part of a profile in your user configuration. You can have multiple profiles, with one + set to active so that you can switch environments. +

+ + . + . + + + true + /path/to/local/repo + + + . + .]]> +

+ The local repository must be an absolute path. +

+

+ Configuring a Proxy +

+

+ You can configure a proxy to use for some or all of your HTTP requests in Maven 2.0. The username and + password are only required if your proxy requires basic authentication (note that later alphas will support + storing your passwords in a secured keystore - in the mean time, please ensure your settings.xml + file is secured with permissions appropriate for your operating system). +

+

+ The nonProxyHosts setting accepts wild cards, and each host not to proxy is separated by the + | character. This matches the + JDK configuration equivalent. +

+ + . + . + + + true + http + http://proxy.somewhere.com + 8080 + proxyuser + somepassword + www.google.com|*.somewhere.com + + + . + .]]> +

+ Deployment Settings +

+

+ Repositories to deploy to are defined in a project in the <distributionManagement> section. + However, you cannot put your username, password, or other security settings in that project. For that reason, + you should add a server definition to your own settings with an id that matches that of the + deployment repository in the project. +

+

+ Which settings are required will depend on the type of repository you are deploying to. As of the first release, + only SCP deployments and file deployments are supported by default, so only the following SCP configuration + is needed: +

+ + . + . + + + repo1 + repouser + + + + . + .]]>
diff --git a/maven-site/src/site/xdoc/index.xml b/maven-site/src/site/xdoc/index.xml index 96863c04b4..b02f700823 100644 --- a/maven-site/src/site/xdoc/index.xml +++ b/maven-site/src/site/xdoc/index.xml @@ -16,7 +16,7 @@ (685K)

-