How do I use Maven through a proxy

Question

I want to share my experience of using maven through a proxy   You would most likely face exceptions and messages like    repository metadata for   org apache maven plugins  could not be retrieved from  repository  central due to an error  Error transferring file  Connection refused  connect   or    WARNING  Failed to retrieve plugin descriptor for org apache maven plugins maven-clean- plugin 2 5  Plugin org apache maven plugins maven-clean-plugin 2 5 or one of its  dependencies could not be resolved  Failed to read artifact descriptor for  org apache maven plugins maven-clean-plugin jar 2 5   How to configure Maven to use proxy server

User · Answer

To set Maven Proxy    Edit the proxies session in your    m2 settings xml file  If you cant find the file  create one    lt settings gt   lt proxies gt       lt proxy gt           lt id gt httpproxy lt  id gt           lt active gt true lt  active gt           lt protocol gt http lt  protocol gt           lt host gt your-proxy-host lt  host gt           lt port gt your-proxy-port lt  port gt           lt nonProxyHosts gt local net some host com lt  nonProxyHosts gt       lt  proxy gt   lt proxy gt           lt id gt httpsproxy lt  id gt           lt active gt true lt  active gt           lt protocol gt https lt  protocol gt           lt host gt your-proxy-host lt  host gt           lt port gt your-proxy-port lt  port gt           lt nonProxyHosts gt local net some host com lt  nonProxyHosts gt       lt  proxy gt    lt  proxies gt   lt  settings gt    or   Edit the proxies session in your  M2 HOME  conf settings xml   Hope it Helps

User · Answer

Those are caused most likely by 2 issues    You need to add proxy configuration to your settings xml  Here s a trick in your username field  Make sure it looks like domain username  Setting domain there and putting this exact slash is important      You might want to use  lt   CDATA    gt  tag if your password contains non xml-friendly characters  I ve noticed maven 2 2 0 does not work sometimes through a proxy at all  where 2 2 1 works perfectly fine    If some of those are omitted - maven could fail with random error messages   Just hope I ve saved somebody from googling around this issue for 6 hours  like I did

User · Answer

The above postings helped in resolving my problem  In addition to the above I had to make the following changes to make it work       Modified Maven s JRE net settings  jre lib net properties  to use system proxy setting   https proxyHost proxy DNS https proxyPort proxy port  Included proxy server settings in settings xml  I did not provide username and password settings as to use NTLM authentication

User · Answer

Some times you need to add other  lt proxy gt  lt  proxy gt  tags  and specify the https in the protocol tags   lt protocol gt https lt  protocol gt

User · Answer

Also note that some plugins  remote-resources comes to mind  use a really old library that only accepts proxy configuration through MAVEN OPTS   -Dhttp proxyHost  lt host gt  -Dhttp proxyPort  lt port gt  -Dhttps proxyHost  lt host gt  -Dhttps proxyPort  lt port gt    You might be stuck on auth for this one

User · Answer

How to use a socks proxy   Set up a SSH tunnel to a server somewhere   ssh -D  PORT  USER  SERVER   Linux  bash    export MAVEN OPTS  -DsocksProxyHost 127 0 0 1 -DsocksProxyPort  PORT    Windows   set MAVEN OPTS  -DsocksProxyHost 127 0 0 1 -DsocksProxyPort  PORT

User · Answer

For details of setting up a proxy for Maven  see the mini guide   Essentially you need to ensure the proxies section in either the global settings   maven install  conf settings xml   or user settings    user home   m2 settings xml  is configured correctly  It is better to do this in your user settings to avoid storing the password in plain text in a public location   Maven 2 1 introduced password encryption  but I ve not got round to checking if the encryption applies for the proxy settings as well as repository passwords  don t see why it wouldn t though    For info  there is a commented-out proxy configuration in your settings xml and instructions on how to modify it   From the mini-guide  your settings should look something like this    lt settings xmlns  http   maven apache org SETTINGS 1 0 0    xmlns xsi  http   www w3 org 2001 XMLSchema-instance    xsi schemaLocation  http   maven apache org SETTINGS 1 0 0                   http   maven apache org xsd settings-1 0 0 xsd  gt           lt proxies gt       lt proxy gt         lt active gt true lt  active gt         lt protocol gt http lt  protocol gt         lt host gt proxy somewhere com lt  host gt         lt port gt 8080 lt  port gt         lt username gt proxyuser lt  username gt         lt password gt somepassword lt  password gt         lt nonProxyHosts gt www google com   somewhere com lt  nonProxyHosts gt       lt  proxy gt     lt  proxies gt         lt  settings gt

User · Answer

I know this is not really an answer to the question  but it might be worth knowing for someone searching this post  It is also possible to install a Maven repository proxy like nexus    Your maven would be configured to contact the local Nexus proxy  and Nexus would then retrieve  and cache  the artifacts  It can be configured through a web interface and has support for  http  proxies    This can be an advantage  especially in a company setting  as artefacts are locally available and can be downloaded fast  and you are not that dependent on the availability of external Maven repositories anymore   To link back to the question  with Nexus there is a nice GUI for the proxy configuration  and it needs to be done on one place only  and not for every developer

User · Answer

Except for techniques mentioned above  with some effort  you can run maven through proxy using jproxyloader library  there is example on page how to do this  http   jproxyloader sourceforge net    This allows set up socks proxy only for downloading artifacts   In solution mentioned by duanni  setting -DsocksProxyHost  there is one problem  If you have integration tests running against local database  or another tests connecting to url which should not go via proxy   These tests will stop working because connections to database will also be directed to proxy  With help of jProxyLoader you can set up proxy only for nexus host  Additionally if you want you can pass connections to database through another proxy

User · Answer

And to add to this topic  here re my experiences below    Really odd and time consuming so I thought it was worth adding   I ve had a similar problem trying to built the portlet-bridge on Windows  getting the following errors    Downloading  http   repo1 maven org maven2 org apache portals bridges-pom 1 0 bridges-pom-1 0 pom  DEBUG  Reading resolution tracking file C  Documents and Settings myuser  m2 repository org apache portals bridges-pom 1 0 bridges-pom-1 0 pom lastUpdated  DEBUG  Writing resolution tracking file C  Documents and Settings myuser  m2 repository org apache portals bridges-pom 1 0 bridges-pom-1 0 pom lastUpdated  ERROR  The build could not read 1 project -   Help 1  org apache maven project ProjectBuildingException  Some problems were encountered while processing the POMs   FATAL  Non-resolvable parent POM  Could not transfer artifact org apache portals bridges-pom pom 1 0 from to central  http   repo1 maven org maven2   Error transferring file  repo1 maven org and  parent relativePath  points at wrong local POM   line 23  column 11      ERROR    The project org apache portals bridges portals-bridges-common 2 0  H  path to project portals-bridges-common-2 0 pom xml  has 1 error  ERROR      Non-resolvable parent POM  Could not transfer artifact org apache portals bridges-pom pom 1 0 from to central  http   repo1 maven org maven2   Error transferring file  repo1 maven org and  parent relativePath  points at wrong local POM   line 23  column 11  Unknown host repo1 maven org -   Help 2       ERROR  For more information about the errors and possible solutions  please read the following articles   ERROR   Help 1  http   cwiki apache org confluence display MAVEN ProjectBuildingException  ERROR   Help 2  http   cwiki apache org confluence display MAVEN UnresolvableModelException   I tried a couple of things  following a bit of surfing    Tried to set the parent relativePath as empty so that maven didn t think the parent was local  This is as per the suggestion on SO at Hudson build fail  Non-resolvable parent POM and in this nabble forum  This had no effect  I also tried ensuring the repository was explicitly listed in my settings xml but this had no effect either  I then ensured mvn was forced to lookup the repository  rather than rely on it s own history  as discussed in this blog by Sarthon  Unfortunately  this wasn t the issue either  In some desperation  I then revisited my MAVEN OPTS to ensure I wasn t falling foul of my proxy settings  These were correct  albeit with the value unquoted      set MAVEN OPTS  -Dhttp proxyHost myproxy mycompany com -Dhttp proxyPort 8080 -Xmx256m  So  finally  I moved the proxy config into my settings xml and this worked         lt proxies gt         lt proxy gt           lt id gt genproxy lt  id gt           lt active gt true lt  active gt           lt protocol gt http lt  protocol gt           lt  --username gt proxyuser lt  username-- gt           lt  --password gt proxypass lt  password-- gt           lt host gt myproxy mycompany com lt  host gt           lt port gt 8080 lt  port gt           lt nonProxyHosts gt   mycompany com 127 0 0 1 lt  nonProxyHosts gt         lt  proxy gt       lt  proxies gt    Really not sure why my original MAVEN OPTS wasn t working  quotes   while the settings xml config did work  I d like to reverse the fix and check each step again but have wasted too much time  Will report back as and when

User · Answer

Thanks  krosenvold   If the settings file changes don t work  try this in the command prompt having the POM file   mvn install -Dhttp proxyHost abcproxy -Dhttp proxyPort 8080 -Dhttps proxyHost abcproxy -Dhttps proxyPort 8080   This has helped me immediately after a password change

User · Answer

if you are new to proxy setup for Maven In my case first go and check your Home Folder weather there is  m2 folder and in it there should be a file named settings xml if not create it   and paste this and change host and port then if needed change the nonProxyHosts     Home Folder - C  Users   UserName     lt settings gt   lt proxies gt       lt proxy gt           lt id gt httpproxy lt  id gt           lt active gt true lt  active gt           lt protocol gt http lt  protocol gt           lt host gt your-proxy-host lt  host gt           lt port gt your-proxy-port lt  port gt           lt nonProxyHosts gt localhost lt  nonProxyHosts gt       lt  proxy gt   lt proxy gt           lt id gt httpsproxy lt  id gt           lt active gt true lt  active gt           lt protocol gt https lt  protocol gt           lt host gt your-proxy-host lt  host gt           lt port gt your-proxy-port lt  port gt           lt nonProxyHosts gt localhost lt  nonProxyHosts gt       lt  proxy gt    lt  proxies gt   lt  settings gt    If any case this does not success go and do the changes in this location of Home Folder    conf settings xml   I am using Eclipse as my IDE Hope this will help     Note  To remove the proxy just move settings xml to some where else

User · Answer

Maven provides a built-in method of doing this  via a file called settings xml  and this has been covered in other answers   However  it is customary  particularly in Linux  for command-line tools to automatically use the proxy specified by the environment variable https proxy  To follow the Don t repeat yourself principle  which is intended to help you avoid mistakes   it would be nice if mvn could automatically work with that too  Here s a shell script that makes the necessary conversions      usr bin env bash  function javaproxy          using  quot Shell Parameter Expansion quot      request scheme  1   proxy  2     notscheme   echo   proxy           parse     scheme   echo   proxy   notscheme       remove     scheme   echo   scheme          strip     hostport   echo   proxy           parse     host   echo   hostport         parse     port   echo   hostport   host       remove     port   echo   port        strip     scheme   echo   scheme -http      default     host   echo   host -localhost      default     port   echo   port -8080      default     echo -n  quot  -D  request scheme  proxyHost   host  quot      echo -n  quot  -D  request scheme  proxyPort   port  quot     JTO  quot  quot   if    http proxy     then     JTO  quot   JTO   javaproxy http   http proxy   quot  fi  if    https proxy     then     JTO  quot   JTO   javaproxy https   https proxy   quot  fi  if    no proxy     then     JTO  quot   JTO  -Dhttp nonProxyHosts   echo   quot   no proxy   quot  tr          quot  fi     export JAVA TOOL OPTIONS   JTO     echo  quot JAVA TOOL OPTIONS   JAVA TOOL OPTIONS  quot      mvn friendliness options  --update-snapshots    mvn   mvn friendliness options      You might name this something like proxied mvn and run it as    https proxy http   localhost 58080   proxied mvn clean package  Alternatively  you could just move the environment setup into your startup scripts  gotchas There are many things that can go wrong when trying to configure Maven for access to a Nexus through a proxy   Hopefully  this script will help with some of the most finicky issues  but others remain   Nexus credentials available and correct  only if required  Check with mvn help effective-settings  Maven caching   quot resolution will not be reattempted quot  mvn clean package --update-snapshots  Maven wall-of-text output -- you have to look closely at the output to make sure errors messages aren t subtly different between runs  Older versions of Java may require  JAVA OPTIONS instead of JAVA TOOL OPTIONS    epilogue There is more than one kind of Proxy   Correspondingly  there is more than one way that this question has been interpreted -- contributing to the large number of disparate answers here  I have explicitly addressed the case of a  forward HTTP HTTPS  web proxy server  which is used to access the internet from within a company network  for some companies    This may be notably distinct from a SOCKS proxy  which has also been addressed in some answers here  Oh by the way  since it uses JAVA TOOL OPTIONS  this solutions can be applied to running your other Java applications inside a proxy too   Parting hint     My example above uses http   localhost 58080   This is because I ve set up port-forwarding from my CLIENT PROXY localhost 58080 to the actual network proxy by using WSL on my remote-access client to run  ssh  PROXY CLIENT -R  CLIENT PROXY  SERVER PROXY

User · Answer

If maven works through proxy but not some of the plugins it is invoking  try setting JAVA TOOL OPTIONS as well with -Dhttp  proxy  settings   If you have already JAVA OPTS just do  export JAVA TOOL OPTIONS  JAVA OPTS

User · Answer

I run cntlm localy  configured with NTLMv2 password hashes to authenticate with the corporate proxy  and use   export MAVEN OPTS  -DproxyHost 127 0 0 1 -DproxyPort 3128    to use that proxy from maven  Of course the proxy you use should support cntlm NTLMv2

User · Answer

I also had this problem  and I solved it by editing the settings xml file in my  m2 folder  My settings xml is like this now    lt settings gt     lt proxies gt       lt proxy gt         lt id gt genproxy lt  id gt         lt active gt true lt  active gt         lt protocol gt http lt  protocol gt         lt host gt proxyHost lt  host gt         lt port gt 3128 lt  port gt         lt username gt username lt  username gt         lt password gt password lt  password gt       lt  proxy gt    lt  proxies gt   lt  settings gt

User · Answer

Just to add my own experiences with this  my company s proxy is  http   webproxy intra companyname com 3128  For maven to work via this proxy  the settings have to be exactly like this   lt settings gt     lt proxies gt       lt proxy gt         lt id gt default lt  id gt         lt active gt true lt  active gt         lt protocol gt http lt  protocol gt         lt host gt webproxy intra companyname com lt  host gt         lt port gt 3128 lt  port gt       lt  proxy gt     lt  proxies gt   lt  settings gt    Unlike some other proxy-configuration files  the protocol here describes how to connect to the proxy server  not which kinds of protocol should be proxied  The http part of the target has to be split off from the hostname  else it won t work

[maven] How do I use Maven through a proxy?

Examples related to maven

Examples related to proxy