How to use sbt from behind proxy

Question

How do I configure sbt to use a proxy   For example  my build definition needs to connect to GitHub  specifying connection parameters for http proxy  http proxyPort  user  and password   How would I pass in these settings to sbt   Is there an easy way to switch between proxy no-proxy settings for when I work from home

User · Answer

I found an item on the FAQ section of Lightbend Activator useful. I am using Activator, which in turn uses SBT, so not sure if this helps users with just SBT, but if you use Activator, like me, and are behind a proxy, follow the instructions in the "Behind A Proxy" section of the FAQ:

https://www.lightbend.com/activator/docs

Just in case the content disappears, here's a copy-paste:

When running activator behind a proxy, some additional configuration is needed. First, open the activator configuration file, found in your user home directory under ~/.activator/activatorconfig.txt. Note that this file may not exist. Add the following lines (one option per line):

-Dhttp.proxyHost=PUT YOUR PROXY HOST HERE
-Dhttp.proxyPort=PUT YOUR PROXY PORT HERE
-Dhttp.nonProxyHosts="localhost|127.0.0.1"
-Dhttps.proxyHost=PUT YOUR HTTPS PROXY HOST HERE
-Dhttps.proxyPort=PUT YOUR HTTPS PROXY PORT HERE
-Dhttps.nonProxyHosts="localhost|127.0.0.1"

User · Answer

Add both http and https configuration   export JAVA OPTS   JAVA OPTS -Dhttp proxyHost yourserver -Dhttp proxyPort 8080 -Dhttp proxyUser username -Dhttp proxyPassword password   export JAVA OPTS   JAVA OPTS -Dhttps proxyHost yourserver -Dhttps proxyPort 8080 -Dhttps proxyUser username -Dhttps proxyPassword password     https config is must  since many urls referred by the sbt libraries are https   In fact  I even had an extra setting  http proxySet  to  true  in both configuration entries

User · Answer

When I added the proxy info to the  JAVA OPTS   I got an error  -Dhttp proxyHost yourserver was unexpected at this time   I put the proxy info in  SBT OPTS  and it worked

User · Answer

I used  this is a unix environment      export SBT OPTS   SBT OPTS -Dhttp proxyHost myproxy-Dhttp proxyPort myport    This did not work for my setup     export JAVA OPTS   JAVA OPTS -Dhttp proxyHost myproxy-Dhttp proxyPort myport    In sbt sh file     JAVA OPTS          environment variable  if unset uses   java opts  SBT OPTS           environment variable  if unset uses   default sbt opts    But apparently SBT OPTS is used instead of JAVA OPTS

User · Answer

In windows environment simply add following line in the sbt sbtconfig txt  -Dhttp proxyHost PROXYHOST  -Dhttp proxyPort PROXYPORT  -Dhttp proxyUser USERNAME  -Dhttp proxyPassword XXXX   or the Https equivalent  thanks to comments      -Dhttps proxyHost PROXYHOST  -Dhttps proxyPort PROXYPORT  -Dhttps proxyUser USERNAME  -Dhttps proxyPassword XXXX

User · Answer

I found that starting IntelliJ IDEA from terminal let me connect and download over the internet  To start from terminal  type in     idea

User · Answer

If you are using a Proxy which requires authentication  I have a solution for you     As  Faiz explained above  SBT has a very hard time handling proxy requiring authentication  The solution is to bypass this authentication  if you cannot turn off your proxy on demand  corporate proxy for example   To do so  I suggest you use a squid proxy  and configure it with your username and password to access your corporate proxy  See   https   doc ubuntu-fr org squid Then  you can set JAVA OPTS or SBT OPTS environment variables so that SBT connects to your own local squid proxy instead of your corporate proxy       export JAVA OPTS    -Dhttps proxyHost localhost -Dhttps proxyPort 3128 -Dhttp proxyHost localhost -Dhttp proxyPort 3128     just c c this in your bashrc without modifying anything and it should work fine    The trick is that Squid Proxy does not require any authentication  and acts as an intermediate between SBT and your other proxy   If you have troubles in applying this advise  please let me know   Regards   Edgar

User · Answer

Try providing the proxy details as parameters  sbt compile -Dhttps proxyHost localhost -Dhttps proxyPort port -Dhttp proxyHost localhost -Dhttp proxyPort port   If that is not working then try with JAVA OPTS  non windows   export JAVA OPTS    -Dhttps proxyHost localhost -Dhttps proxyPort port -Dhttp proxyHost localhost -Dhttp proxyPort port   sbt compile   or   windows   set JAVA OPTS    -Dhttps proxyHost localhost -Dhttps proxyPort port -Dhttp proxyHost localhost -Dhttp proxyPort port  sbt compile   if nothing works then set SBT OPTS   non windows   export SBT OPTS    -Dhttps proxyHost localhost -Dhttps proxyPort port -Dhttp proxyHost localhost -Dhttp proxyPort port   sbt compile   or   windows   set SBT OPTS    -Dhttps proxyHost localhost -Dhttps proxyPort port -Dhttp proxyHost localhost -Dhttp proxyPort port  sbt compile

User · Answer

For Windows users  enter the following command    set JAVA OPTS -Dhttp proxySet true -Dhttp proxyHost  Your Proxy server  -Dhttp proxyPort 8080

User · Answer

Using  sbt -Dhttp proxyHost yourServer-Dhttps proxyHost yourServer -Dhttp proxyPort yourPort -Dhttps proxyPort yourPort   works in Ubuntu 15 10 x86 64 x86 64 GNU Linux    Replace yourServer by the proper address without the http    nor https    prefixes in Dhttp and Dhttps  respectively  Remember to avoid the quotation marks  No usr pass included in the code-line  to include that just add -Dhttp proxyUser usr -Dhttp proxyPassword pass with the same typing criteria  Thanks  Jacek Laskowski   Cheers

User · Answer

On Mac OS X   El Capitan you can set java environment variables    launchctl setenv  JAVA OPTIONS  -Dhttp proxyHost 192 168 1 54 -Dhttp proxyPort 9999

User · Answer

SBT use both HTTP HTTPS SFTP SSH and other kind of connections to a repository  so when behind a proxy  these protocols should be available    In most simple cases on Windows  you just need to pass proxy parameters options to JVM  like   java -Dhttp proxyHost myproxy -Dhttp proxyPort 8080   That will do   But if not  there are few things you should be aware of    whether if you are making a HTTPS connection to the repository  whether sever certificates been imported to jre cacerts whether your proxy would replace your server certificates   to solve first  you should pass https proxy parameter to jvm  like   java -Dhttps proxyHost myproxy -Dhttps proxyPort 8080 -Djavax net ssl trustStore   TRUST STORE PATH    to solve the second  you should import the ca  there are a lot of tips   to solve the third  you maybe could considering using a authentication proxy   to Simplify the config of SBT  it provide sbtconfig txt and sbtops in the conf directory  look into it    Reference  http   www scala-sbt org 0 13 docs Setup-Notes html http   www scala-sbt org 1 0 docs Publishing html

User · Answer

sbt respects the usual environment variables for http proxy settings   export JAVA OPTS   JAVA OPTS -Dhttp proxyHost yourserver -Dhttp proxyPort 8080 -Dhttp proxyUser username -Dhttp proxyPassword password     That s of course  assuming Unix  Linux OSX etc   On windows you could just set the same environment variable   JAVA OPTS   as usual in the Windows way    Then run sbt as usual   sbt   Switching between proxy no-proxy should be a matter of setting up a little script that you can  slurp  in whenever you need it   Gotchas   Don t include  http     in the yourserver value Don t include the port in the yourserver value You probably also want to include https proxyHost and https proxyPort since a lot of stuff works over https If your proxy requires authentication  don t even bother trying unless it just uses Basic Authentication as SBT doesn t support anything else   Also always beware clear texting credentials into environment variables  Be sure to remove the commands from your  bash history using a text editing method that won t create trace files  technically you should shred or srm the entire file    If you are on Windows  don t worry about it  your security is already messed up you can t do any more harm

User · Answer

sbt works in a fairly standard way comparing to the way other JVM-based projects are usually configured   sbt is in fact two  subsystems  - the launcher and the core  It s usually xsbt boot Boot that gets executed before the core starts up with the features we all know  and some even like    It s therefore a matter of how you execute sbt that says how you could set up a proxy for HTTP  HTTPS and FTP network traffic   The following is the entire list of the available properties that can be set for any Java application  sbt including  that instruct the Java API to route communication through a proxy    http proxy http proxy user http proxy pass http proxyHost http proxyPort http proxyUser http proxyPassword   Replace http above with https and ftp to get the list of the properties for the services   Some sbt scripts use JAVA OPTS to set up the proxy settings with -Dhttp proxyHost and -Dhttp proxyPort amongst the others  listed above   See Java Networking and Proxies   Some scripts come with their own way of setting up proxy configuration using the SBT OPTS property   sbtopts or  only on Windows   SBT HOME  conf sbtconfig txt  You can use them to specifically set sbt to use proxies while the other JVM-based applications are not affected at all   From the sbt command line tool     jvm options and output control JAVA OPTS          environment variable  if unset uses   java opts  SBT OPTS           environment variable  if unset uses   default sbt opts   sbtopts           if this file exists in the current directory  it is                    prepended to the runner args  etc sbt sbtopts   if this file exists  it is prepended to the runner args -Dkey val          pass -Dkey val directly to the java runtime -J-X               pass option -X directly to the java runtime                      -J is stripped  -S-X               add -X to sbt s scalacOptions  -S is stripped    And here comes an excerpt from sbt bat    REM Envioronment   REM JAVA HOME - location of a JDK home dir  mandatory   REM SBT OPTS  - JVM options  optional   REM Configuration   REM sbtconfig txt found in the SBT HOME    Be careful with sbtconfig txt that just works on Windows only  When you use cygwin the file is not consulted and you will have to resort to using the other approaches   I m using sbt with the following script    JAVA HOME bin java  SBT OPTS -jar  Users jacek  ivy2 local org scala-sbt sbt-launch  SBT LAUNCHER VERSION-SNAPSHOT jars sbt-launch jar        The point of the script is to use the latest version of sbt built from the sources  that s why I m using  Users jacek  ivy2 local org scala-sbt sbt-launch  SBT LAUNCHER VERSION-SNAPSHOT jars sbt-launch jar  with  SBT OPTS property as a means of passing JVM properties to the JVM sbt uses   The script above lets me to set proxy on command line on MacOS X as follows   SBT OPTS  -Dhttp proxyHost proxyhost -Dhttp proxyPort 9999  sbt   As you can see  there are many approaches to set proxy for sbt that all pretty much boil down to set a proxy for the JVM sbt uses

User · Answer

For those still landing on this thread trying to find where how to configure HTTP proxy in IntelliJ  here s how I managed to get it to work for me  I hope this helps    Note  specify your network username and password in the corresponding boxes  -

User · Answer

To provide one answer that will work for all Windows-users  Add the following to your sbtconfig txt  C  Program Files  x86  sbt conf  -Dhttp proxyHost XXXXXXX -Dhttp proxyPort YYYY -Dhttp proxySet true -Dhttps proxyHost XXXXXXX -Dhttps proxyPort YYYY -Dhttps proxySet true  Replace both XXXXXXX with your proxyHost  and both YYYY with your proxyPort  If you get the error  quot Could not find or load main class quot  you need to set your JAVA HOME  set JAVA HOME C  Progra 1 Java jdkxxxxxx  When on 64-bit windows  use   Progra 1    Program Files  Progra 2    Program Files x86

[sbt] How to use sbt from behind proxy?

Examples related to sbt