Modified bashrc configuration for Git for Windows to work with both Git and Vagrant.
Introduction
In my last post, Easy Configuration of Git for Windows on a Corporate Network, I demonstrated how to configure Git for Windows to work when switching between working on-site, working off-site through a VPN, and working totally off the corporate network. Dealing with a proxy server was the main concern. The solution worked fine for Git. However, after further testing with Vagrant using the Git Bash interactive shell, I ran into a snag. Unlike Git, Vagrant did not seem to like the standard URI, which contained ‘domain\username’:
http(s)://domain\username:password@proxy_server:proxy_port
In a corporate environment with LDAP, qualifying the username with a domain is normal, like ‘domain\username’. But, when trying to install a Vagrant plug-in with a command such as ‘vagrant plugin install vagrant-omnibus’, I received an error similar to the following (proxy details obscured):
$ vagrant plugin install vagrant-omnibus
Installing the 'vagrant-omnibus' plugin. This can take a few minutes...
c:/HashiCorp/Vagrant/embedded/lib/ruby/2.0.0/uri/common.rb:176: in `split':
bad URI(is not URI?): http://domain\username:password@proxy:port
(URI::InvalidURIError)...
Solution
After some research, it seems Vagrant’s ‘common.rb’ URI function does not like the ‘domain\username’ format of the original URI. To fix this problem, I modified the original ‘proxy_on’ function, removing the DOMAIN environment variable. I now suggest using the fully qualified domain name (FQDN) of the proxy server. So, instead of ‘my_proxy’, it would be ‘my_proxy.domain.tld’. The acronym ‘tld’ stands for the top-level domain (tld). Although .com is the most common one, there are over 300 top-level domains, so I don’t want assume yours is ‘.com’. The new proxy URI is as follows:
http(s)://username:password@proxy_server.domain.tld:proxy_port
Although all environments have different characteristics, I have found this change to work, with both Git and Vagrant, in my own environment. After making this change, I was able to install plug-ins and do other similar functions with Vagrant, using the Git Bash interactive shell.
$ vagrant plugin install vagrant-omnibus
Installing the 'vagrant-omnibus' plugin. This can take a few minutes...
Installed the plugin 'vagrant-omnibus (1.2.1)'!
Change to Environment Variables
One change you will notice compared to my last post, and unrelated to the Vagrant domain issue, is a change to PASSWORD, PROXY_SERVER, and PROXY_PORT environment variables. In the last post, I created and exported the PASSWORD, PROXY_SERVER, and PROXY_PORT environment variables within the ‘proxy_on’ function. After further consideration, I permanently moved them to Environment Variables -> User variables. I felt this was a better solution, especially for my password. Instead of my user’s account password residing in the .bashrc file, in plain text, it’s now in my user’s environment variables. Although still not ideal, I felt my password was slightly more secure. Also, since my proxy server address rarely change when I am at work or on the VPN, I felt moving these was easier and cleaner than placing them into the .bashrc file.
The New Code
Verbose version:
| # configure proxy for git while on corporate network | |
| function proxy_on(){ | |
| # assumes $USERDOMAIN, $USERNAME, $USERDNSDOMAIN | |
| # are existing Windows system-level environment variables | |
| # assumes $PASSWORD, $PROXY_SERVER, $PROXY_PORT | |
| # are existing Windows current user-level environment variables (your user) | |
| # environment variables are UPPERCASE even in git bash | |
| export HTTP_PROXY="http://$USERNAME:$PASSWORD@$PROXY_SERVER.$USERDNSDOMAIN:$PROXY_PORT" | |
| export HTTPS_PROXY=$HTTP_PROXY | |
| export FTP_PROXY=$HTTP_PROXY | |
| export SOCKS_PROXY=$HTTP_PROXY | |
| export NO_PROXY="localhost,127.0.0.1,$USERDNSDOMAIN" | |
| # optional for debugging | |
| export GIT_CURL_VERBOSE=1 | |
| # optional Self Signed SSL certs and | |
| # internal CA certificate in an corporate environment | |
| export GIT_SSL_NO_VERIFY=1 | |
| env | grep -e _PROXY -e GIT_ | sort | |
| echo -e "\nProxy-related environment variables set." | |
| } | |
| # remove proxy settings when off corporate network | |
| function proxy_off(){ | |
| variables=( \ | |
| "HTTP_PROXY" "HTTPS_PROXY" "FTP_PROXY" "SOCKS_PROXY" \ | |
| "NO_PROXY" "GIT_CURL_VERBOSE" "GIT_SSL_NO_VERIFY" \ | |
| ) | |
| for i in "${variables[@]}" | |
| do | |
| unset $i | |
| done | |
| env | grep -e _PROXY -e GIT_ | sort | |
| echo -e "\nProxy-related environment variables removed." | |
| } | |
| # if you are always behind a proxy uncomment below | |
| #proxy_on | |
| # increase verbosity of Vagrant output | |
| export VAGRANT_LOG=INFO |
Compact version:
| function proxy_on(){ | |
| export HTTP_PROXY="http://$USERNAME:$PASSWORD@$PROXY_SERVER.$USERDNSDOMAIN:$PROXY_PORT" | |
| export HTTPS_PROXY="$HTTP_PROXY" FTP_PROXY="$HTTP_PROXY" ALL_PROXY="$HTTP_PROXY" \ | |
| NO_PROXY="localhost,127.0.0.1,*.$USERDNSDOMAIN" \ | |
| GIT_CURL_VERBOSE=1 GIT_SSL_NO_VERIFY=1 | |
| echo -e "\nProxy-related environment variables set." | |
| } | |
| function proxy_off(){ | |
| variables=( "HTTP_PROXY" "HTTPS_PROXY" "FTP_PROXY" "ALL_PROXY" \ | |
| "NO_PROXY" "GIT_CURL_VERBOSE" "GIT_SSL_NO_VERIFY" ) | |
| for i in "${variables[@]}"; do unset $i; done | |
| echo -e "\nProxy-related environment variables removed." | |
| } | |
| # if you are always behind a proxy uncomment below | |
| #proxy_on | |
| # increase verbosity of Vagrant output | |
| export VAGRANT_LOG=INFO |
Programmatic Ponderings 