Bug 8637 - proxy settings are not accurate for SOCKS proxy
Summary: proxy settings are not accurate for SOCKS proxy
Status: VERIFIED FIXED
Alias: None
Product: General Docs
Classification: Documentation
Component: docs-general (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Medium+ normal
Target Milestone: 2.1 M3
Assignee: Scott Rifenbark
QA Contact: Bogdan Alexandru Voiculescu
URL:
Whiteboard: 04 Feb 2016: RESOLVED
Depends on:
Blocks:
 
Reported: 2015-11-03 20:11 UTC by Liam R. Howlett
Modified: 2016-02-05 11:04 UTC (History)
4 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Liam R. Howlett 2015-11-03 20:11:57 UTC
https://wiki.yoctoproject.org/wiki/Working_Behind_a_Network_Proxy is not correct for socks proxy.

wget of https://eula-downloads.yoctoproject.org/index.php in CONNECTIVITY_CHECK_URIS will fail, and thus the user will get the message:

 Failed to fetch test data from the network. Please ensure your network is configured correctly.

Please update the wiki and any other documentation in regards to proxy to state that SOCKS proxy need the user to:

export SOCKS_SERVER=`server:port`
unset http_proxy
unset https_proxy
unset ftp_proxy
Comment 1 Scott Rifenbark 2016-01-15 15:43:54 UTC
Hi, 

I don't update the wiki so we need someone to do that.  I could update it if needed but I don't understand what changes specifically need to be made.  I would need help from someone relating the information from Liam into the actual wiki page.  

In the ref-manual, there are two FAQ entries that deal with proxy: 14.12 and 14.22.  You can see these in the FAQ section (http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#faq)

Regarding 14.12, it says:

  Most source fetching by the OpenEmbedded build system is done by wget 
  and you therefore need to specify the proxy settings in a .wgetrc file 
  in your home directory. Here are some example settings:

     http_proxy = http://proxy.yoyodyne.com:18023/
     ftp_proxy = http://proxy.yoyodyne.com:18023/
                
  The Yocto Project also includes a site.conf.sample file that shows how to 
  configure CVS and Git proxy servers if needed. 

Would we just replace the two example settings with:

  export SOCKS_SERVER=`server:port`
  unset http_proxy
  unset https_proxy
  unset ftp_proxy

Regarding FAQ 14.22.  It looks to me like that would not change?  Again, I am no expert on this stuff so I need some guidance.  

These are the only two areas in the YP doc set I believe would be impacted for this issue.  Comments?

Thanks,
Scott
Comment 2 Liam R. Howlett 2016-02-02 16:20:14 UTC
No, we should not just replace the example.  These are two different types of proxies.

We should leave what is there but add another topic about the socks type of proxy.

Perhaps something like:

  Most source fetching by the OpenEmbedded build system is done by wget 
  and you therefore need to specify the proxy settings in a .wgetrc file 
  in your home directory. Below are some example settings for different
  proxy types.

  Http/FTP proxy:
     http_proxy = http://proxy.yoyodyne.com:18023/
     ftp_proxy = http://proxy.yoyodyne.com:18023/

  socks proxy:
     export SOCKS_SERVER=`server:port`
     unset http_proxy
     unset https_proxy
     unset ftp_proxy
                
  The Yocto Project also includes a site.conf.sample file that shows how to 
  configure CVS and Git proxy servers if needed. 

===============

Should the site.conf.sample be updated as well?
Comment 3 Liam R. Howlett 2016-02-02 16:24:26 UTC
Scott, is this enough information to unblock your work on the bug?
Comment 4 Scott Rifenbark 2016-02-04 16:23:20 UTC
Thanks, 

I will see where I can work that into the docs... I could add a new FAQ entry specifically to address it.  I will send a review link when I get something in.

Scott
Comment 5 Scott Rifenbark 2016-02-04 16:47:55 UTC
Liam,

After looking more closely at your suggestion, I see that you meant to add another example to the existing 14.12 FAQ entry.  Take a look at 14.12 in http://www.yoctoproject.org/docs/temp/ref-manual/ref-manual.html#faq and let me know.  It is basically verbatim to what you suggested.  I did assume that the line:

export SOCKS_SERVER=`server:port`

should have "server" and "port" as user-input values so you will see that they are both formatted in italics, which indicate real values must be provided.

Let me know if this works.

Thanks,
Scott
Comment 6 Liam R. Howlett 2016-02-04 16:53:51 UTC
Hello Scott,

This looks good with one caviate:

/etc/wgetrc has an entry that is not in the wiki for HTTPS.  I noticed this since the socks example has an unset for https_proxy

See below (from /etc/wgetrc):

# You can set the default proxies for Wget to use for http, https, and ftp.
# They will override the value in the environment.
#https_proxy = http://proxy.yoyodyne.com:18023/
#http_proxy = http://proxy.yoyodyne.com:18023/
#ftp_proxy = http://proxy.yoyodyne.com:18023/


I think this should be added to the non-socks configuration example.
Comment 7 Scott Rifenbark 2016-02-04 16:58:48 UTC
Liam, 

Ok - I have added that to the example.  You can see it at http://www.yoctoproject.org/docs/temp/ref-manual/ref-manual.html#faq for 4.12.  I will mark this as RESOLVED now and set the doc flag to "done."  

Thanks for you help!

Scott
Comment 8 Bogdan Alexandru Voiculescu 2016-02-05 11:04:40 UTC
Verified on http://www.yoctoproject.org/docs/temp/ref-manual/ref-manual.html#idm45853935249216