Working Behind a Network Proxy - Revision history

Joshua Lock: Remove leading dot from domains in no_proxy, leading dot no longer works for many modern distros and this now matches W3C documentation on proxy variables. See discussion in https://bugzilla.yoctoproject.org/show_bug.cgi?id=10952

2017-03-02T16:50:10Z

Remove leading dot from domains in no_proxy, leading dot no longer works for many modern distros and this now matches W3C documentation on proxy variables. See discussion in https://bugzilla.yoctoproject.org/show_bug.cgi?id=10952

← Older revision		Revision as of 16:50, 2 March 2017
Line 14:		Line 14:
	export ALL_PROXY='socks://myproxy.example.com:1080/'		export ALL_PROXY='socks://myproxy.example.com:1080/'
	export all_proxy='socks://myproxy.example.com:1080/'		export all_proxy='socks://myproxy.example.com:1080/'
	export no_proxy='.example.com'		export no_proxy='example.com'

	== Git Proxy Configuration ==		== Git Proxy Configuration ==
Line 38:		Line 38:
	http_proxy = http://socks.example.com:1080		http_proxy = http://socks.example.com:1080
	ftp_proxy = http://socks.example.com:1080		ftp_proxy = http://socks.example.com:1080
	no_proxy = .example.com:1080;127.0.0.1		no_proxy = example.com:1080;127.0.0.1
	use_proxy = on		use_proxy = on

Henry Bruce at 23:52, 2 August 2016

2016-08-02T23:52:41Z

← Older revision		Revision as of 23:52, 2 August 2016
Line 1:		Line 1:
	~~This page lists~~ some ~~configuration tips for working behind~~ a ~~proxy~~.		= Background =
			The Yocto Project build system provides the tools and environment to build the packages that comprise a bootable Linux image. All the sources for the packages must be fetched through various means, including wget, git, and others. You need to configure your system to work with your corporate proxies and there are two options for doing this
			# '''Environment variables and configuration files''' - this is the traditional and least intrusive option but involves a number of steps and it can fail in some situations.
			# '''Chameleonsocks''' - this is [https://github.com/darkk/redsocks Redsocks] auto-configured in a [https://www.docker.com/ docker] container, the Yocto team's favorite option. If in doubt, go with this option.

			= Option 1: Environment Variables and Configuration Files =

	== HTTP/HTTPS/FTP Setup ==		== HTTP/HTTPS/FTP Setup ==

	Set the following environment variables in your <tt>~/.bashrc</tt> file. This example uses the same proxy server and port number for all three protocols.		Set the following environment variables in your <tt>~/.bashrc</tt> file. This example uses the same proxy server and port number for all three protocols.

Line 8:		Line 12:
	export https_proxy='https://myproxy.example.com:1080/'		export https_proxy='https://myproxy.example.com:1080/'
	export ftp_proxy='http://myproxy.example.com:1080/'		export ftp_proxy='http://myproxy.example.com:1080/'
			export ALL_PROXY='socks://myproxy.example.com:1080/'
			export all_proxy='socks://myproxy.example.com:1080/'
	export no_proxy='.example.com'		export no_proxy='.example.com'

	== Git ~~Setup~~==		== Git Proxy Configuration ==
	~~Ensure~~ you ~~have~~ socat installed~~, copy <tt>~~scripts/oe-git-proxy~~</tt>~~ to a ~~directory included~~ in your PATH ~~and set~~ the ~~following in your configuration~~:		Git allows you to specify a command via GIT_PROXY_COMMAND to proxy its network communications. The script, [http://git.yoctoproject.org/cgit/cgit.cgi/poky/plain/scripts/oe-git-proxy oe-git-proxy], uses socat and standard proxy environment variables. Make sure socat is installed otherwise oe-git-proxy will fail silently.

			Copy [http://git.yoctoproject.org/cgit/cgit.cgi/poky/plain/scripts/oe-git-proxy oe-git-proxy] to a location in your PATH, typically ~/bin/ is a good choice. /usr/local/bin is another common option. oe-git-proxy is provided in poky/scripts/oe-git-proxy, but use the link below to get you bootstrapped. Replacing it with the latest from the poky git repository is recommended.

			$ sudo apt-get install socat
			$ wget http://git.yoctoproject.org/cgit/cgit.cgi/poky/plain/scripts/oe-git-proxy
			$ cp oe-git-proxy ~/bin
			$ chmod +x ~/bin/oe-git-proxy

	GIT_PROXY_COMMAND ~~?= "~~oe-git-proxy"		Update your .bashrc to setup the GIT_PROXY_COMMAND variable. You also need to set the '''NO_PROXY''' variable as oe-git-proxy does no recognize '''no_proxy'''
	~~# Two possible examples - delete the one that doesn~~'~~t apply:~~
	~~ALL_PROXY ?= "socks://socks.example.com:1080"~~
	~~ALL_PROXY ?= "https://proxy.example.com:8080"~~

	~~If you wish~~ to ~~use certain hosts without the proxy, specify them~~ in ~~NO_PROXY. See~~ the ~~script for details on syntax~~.		export GIT_PROXY_COMMAND="oe-git-proxy"
			export NO_PROXY=$no_proxy

			Be sure to '''log out and back in''' for the settings to take effect.

	== Wget Proxy Configuration ==		== Wget Proxy Configuration ==
Line 28:		Line 41:
	use_proxy = on		use_proxy = on

	=~~= Subversion Setup =~~=		= Option 2: Chameleonsocks =
			Chameleonsocks is a containerized proxy solution that is very easy to set up.
	~~You'll need to have the following in your <tt>~~~/.~~subversion~~/~~servers<~~/~~tt> file:~~		* Get files from https://github.com/crops/chameleonsocks
			* Follow instructions in [https://github.com/crops/chameleonsocks/blob/master/README.MD README]
	[~~global]~~
	~~http-proxy-exceptions = *.exception~~.com~~, www~~.~~internal-site.org~~
	~~http-proxy-host = myproxy.example.com~~
	~~http-proxy-port = 1080~~

	~~You can also set ''http-proxy-username'' and ''http-proxy-password'' if your proxy requires authentication.~~

	~~== CVS Setup (this seems useless since we don't have any recipe requiring cvs now) ==~~

	~~For CVS checkouts to work correctly, you need to add some options in your Poky ''local.conf'' file.~~

	~~CVS_PROXY_HOST = "myproxy.example.com"~~
	~~CVS_PROXY_PORT = "1080"~~

Henry Bruce: /* Git Setup */

2016-08-02T23:39:06Z

Git Setup

← Older revision		Revision as of 23:39, 2 August 2016
Line 11:		Line 11:

	== Git Setup==		== Git Setup==

	Ensure you have socat installed, copy <tt>scripts/oe-git-proxy</tt> to a directory included in your PATH and set the following in your configuration:		Ensure you have socat installed, copy <tt>scripts/oe-git-proxy</tt> to a directory included in your PATH and set the following in your configuration:

Line 20:		Line 19:

	If you wish to use certain hosts without the proxy, specify them in NO_PROXY. See the script for details on syntax.		If you wish to use certain hosts without the proxy, specify them in NO_PROXY. See the script for details on syntax.

			== Wget Proxy Configuration ==
			Proxy environment variables are not propagated to all stages of the Yocto build process so sometimes wget cannot pick them up. To workaround this add the following to ~/.wgetrc.
			https_proxy = http://socks.example.com:1080
			http_proxy = http://socks.example.com:1080
			ftp_proxy = http://socks.example.com:1080
			no_proxy = .example.com:1080;127.0.0.1
			use_proxy = on

	== Subversion Setup ==		== Subversion Setup ==

PaulEggleton: Need socat for our git script

2016-03-21T01:42:46Z

Need socat for our git script

← Older revision		Revision as of 01:42, 21 March 2016
Line 12:		Line 12:
	== Git Setup==		== Git Setup==

	~~Copy~~ <tt>scripts/oe-git-proxy</tt> to a directory included in your PATH and set the following in your configuration:		Ensure you have socat installed, copy <tt>scripts/oe-git-proxy</tt> to a directory included in your PATH and set the following in your configuration:

	GIT_PROXY_COMMAND ?= "oe-git-proxy"		GIT_PROXY_COMMAND ?= "oe-git-proxy"

PaulEggleton: Update this very outdated page

2016-03-21T01:38:12Z

Update this very outdated page

@@ Line 3: / Line 3: @@
 == HTTP/HTTPS/FTP Setup ==
-Set the following environment variables in your ~/.bashrc file. This example uses the same proxy server and port number for all three protocols.
+Set the following environment variables in your <tt>~/.bashrc</tt> file. This example uses the same proxy server and port number for all three protocols.
   export http_proxy='http://myproxy.example.com:1080/'
@@ Line 10: / Line 10: @@
   export no_proxy='.example.com'
-== Git Setup (with socat)==
+== Git Setup==
-First make sure you have the socat utility installed on your host (in Ubuntu, this should be a simple command "sudo apt-get install socat")
+Copy <tt>scripts/oe-git-proxy</tt> to a directory included in your PATH and set the following in your configuration:
-Create a script named ''git-proxy'' and put it in /usr/local/bin:
+ GIT_PROXY_COMMAND ?= "oe-git-proxy"
- #!/bin/bash
+If you wish to use certain hosts without the proxy, specify them in NO_PROXY. See the script for details on syntax.
 == Subversion Setup ==
-You'll need to have the following in your ~/.subversion/servers file:
+You'll need to have the following in your <tt>~/.subversion/servers</tt> file:
   [global]

KarthikRamanan: Fixed issue with white spaces for no_proxy

2014-08-27T15:32:47Z

Fixed issue with white spaces for no_proxy

← Older revision		Revision as of 15:32, 27 August 2014
Line 8:		Line 8:
	export https_proxy='https://myproxy.example.com:1080/'		export https_proxy='https://myproxy.example.com:1080/'
	export ftp_proxy='http://myproxy.example.com:1080/'		export ftp_proxy='http://myproxy.example.com:1080/'
	export no_proxy = '.example.com'		export no_proxy='.example.com'

	== Git Setup (with socat)==		== Git Setup (with socat)==

Alexandru.c.georgescu: /* Git Setup (with socat) */

2014-06-16T08:19:24Z

Git Setup (with socat)

← Older revision		Revision as of 08:19, 16 June 2014
Line 19:		Line 19:
	# $1 = hostname, $2 = port		# $1 = hostname, $2 = port
	PROXY=myproxy.example.com		PROXY=myproxy.example.com
	exec socat STDIO SOCKS4:$~~proxy~~:$1:$2		exec socat STDIO SOCKS4:$PROXY:$1:$2
	Then run the following command:		Then run the following command:

Dcui: /* CVS Setup (this seems useless since we don't have any recipe requiring cvs now */

2012-01-12T08:41:26Z

CVS Setup (this seems useless since we don't have any recipe requiring cvs now

← Older revision		Revision as of 08:41, 12 January 2012
Line 66:		Line 66:
	You can also set ''http-proxy-username'' and ''http-proxy-password'' if your proxy requires authentication.		You can also set ''http-proxy-username'' and ''http-proxy-password'' if your proxy requires authentication.

	== CVS Setup (this seems useless since we don't have any recipe requiring cvs now ==		== CVS Setup (this seems useless since we don't have any recipe requiring cvs now) ==

	For CVS checkouts to work correctly, you need to add some options in your Poky ''local.conf'' file.		For CVS checkouts to work correctly, you need to add some options in your Poky ''local.conf'' file.

Dcui: /* CVS Setup */

2012-01-12T08:41:09Z

CVS Setup

← Older revision		Revision as of 08:41, 12 January 2012
Line 66:		Line 66:
	You can also set ''http-proxy-username'' and ''http-proxy-password'' if your proxy requires authentication.		You can also set ''http-proxy-username'' and ''http-proxy-password'' if your proxy requires authentication.

	== CVS Setup ==		== CVS Setup (this seems useless since we don't have any recipe requiring cvs now ==

	For CVS checkouts to work correctly, you need to add some options in your Poky ''local.conf'' file.		For CVS checkouts to work correctly, you need to add some options in your Poky ''local.conf'' file.

Dcui: /* Git Setup (with socat) */

2012-01-12T08:37:15Z

Git Setup (with socat)

← Older revision		Revision as of 08:37, 12 January 2012
Line 19:		Line 19:
	# $1 = hostname, $2 = port		# $1 = hostname, $2 = port
	PROXY=myproxy.example.com		PROXY=myproxy.example.com
	exec socat STDIO SOCKS4:$proxy:$1:$2		exec socat STDIO SOCKS4:$proxy:$1:$2

	Then run the following command:		Then run the following command: