Nils Winkler
commit
16bc7843c4
33
README.md
33
README.md
|
|
@ -59,7 +59,7 @@ Alternatively, you can preview the themes in your own shell using `BASH_PREVIEW=
|
|||
## Misc
|
||||
|
||||
### Bash Profile Aliases
|
||||
Bash it creates a 'reload' alias that makes it convenient to reload
|
||||
Bash it creates a `reload` alias that makes it convenient to reload
|
||||
your bash profile when you make changes.
|
||||
|
||||
### Prompt Version Control Check
|
||||
|
|
@ -105,6 +105,37 @@ Unset `BASH_IT_LEGACY_PASS` to have Bash it **return to default behavior**:
|
|||
|
||||
* `unset BASH_IT_LEGACY_PASS`
|
||||
|
||||
#### Proxy Support
|
||||
|
||||
If you are working in a corporate environment where you have to go through a proxy server for internet access, then you know how painful it is to configure the OS proxy variables in the shell, especially if you are switching between environments, e.g. office (with proxy) and home (without proxy).
|
||||
|
||||
The Bash shell (and many shell tools) use the following variables to define the proxy to use:
|
||||
|
||||
* `HTTP_PROXY` (and `http_proxy`): Defines the proxy server for HTTP requests
|
||||
* `HTTPS_PROXY` (and `https_proxy`): Defines the proxy server for HTTPS requests
|
||||
* `ALL_PROXY` (and `all_proxy`): Used by some tools for the same purpose as above
|
||||
* `NO_PROXY` (and `no_proxy`): Comma-separated list of hostnames that don't have to go through the proxy
|
||||
|
||||
Bash it's `proxy` plugin allows to enable and disable these variables with a simple command. To start using the `proxy` plugin, run the following:
|
||||
|
||||
```bash
|
||||
bash-it enable plugin proxy
|
||||
```
|
||||
|
||||
Bash it also provides support for enabling/disabling proxy settings for various shell tools. The following backends are currently supported (in addition to the shell's environment variables): Git, SVN, npm, ssh. The `proxy` plugin changes the configuration files of these tools to enable or disable the proxy settings.
|
||||
|
||||
Bash-it uses the following variables to set the shell's proxy settings when you call `enable-proxy`.
|
||||
These variables are best defined in a custom script in Bash-it's custom script folder (`$BASH_IT/custom`), e.g. `$BASH_IT/custom/proxy.env.bash`
|
||||
* `BASH_IT_HTTP_PROXY` and `BASH_IT_HTTPS_PROXY`: Define the proxy URL to be used, e.g. 'http://localhost:1234'
|
||||
* `BASH_IT_NO_PROXY`: A comma-separated list of proxy exclusions, e.g. `127.0.0.1,localhost`
|
||||
|
||||
Once you have defined these variables (and have run `reload` to load the changes), you can use the following commands to enable or disable the proxy settings in your current shell:
|
||||
|
||||
* `enable-proxy`: This sets the shell's proxy environment variables and configures proxy support in your SVN, npm and SSH configuration files.
|
||||
* `disable-proxy`: This unsets the shell's proxy environment variables and disables proxy support in your SVN, npm and SSH configuration files.
|
||||
|
||||
There are many more proxy commands, e.g. for changing the local Git project's proxy settings. Run `glossary proxy` to show the available proxy functions with a short description.
|
||||
|
||||
## Help out
|
||||
|
||||
We think everyone has their own custom scripts accumulated over time. And so, following in the footsteps of oh-my-zsh, Bash it is a framework for easily customizing your bash shell. Everyone's got a custom toolbox, so let's start making them even better, **as a community!**
|
||||
|
|
|
|||
|
|
@ -0,0 +1,388 @@
|
|||
cite about-plugin
|
||||
about-plugin 'Proxy Tools'
|
||||
|
||||
disable-proxy ()
|
||||
{
|
||||
about 'Disables proxy settings for Bash, npm and SSH'
|
||||
group 'proxy'
|
||||
|
||||
unset http_proxy
|
||||
unset https_proxy
|
||||
unset HTTP_PROXY
|
||||
unset HTTPS_PROXY
|
||||
unset ALL_PROXY
|
||||
unset no_proxy
|
||||
unset NO_PROXY
|
||||
echo "Disabled proxy environment variables"
|
||||
|
||||
npm-disable-proxy
|
||||
ssh-disable-proxy
|
||||
svn-disable-proxy
|
||||
}
|
||||
|
||||
enable-proxy ()
|
||||
{
|
||||
about 'Enables proxy settings for Bash, npm and SSH'
|
||||
group 'proxy'
|
||||
|
||||
export http_proxy=$BASH_IT_HTTP_PROXY
|
||||
export https_proxy=$BASH_IT_HTTPS_PROXY
|
||||
export HTTP_PROXY=$http_proxy
|
||||
export HTTPS_PROXY=$https_proxy
|
||||
export ALL_PROXY=$http_proxy
|
||||
export no_proxy=$BASH_IT_NO_PROXY
|
||||
export NO_PROXY=$no_proxy
|
||||
echo "Enabled proxy environment variables"
|
||||
|
||||
npm-enable-proxy
|
||||
ssh-enable-proxy
|
||||
svn-enable-proxy
|
||||
}
|
||||
|
||||
enable-proxy-alt ()
|
||||
{
|
||||
about 'Enables alternate proxy settings for Bash, npm and SSH'
|
||||
group 'proxy'
|
||||
|
||||
export http_proxy=$BASH_IT_HTTP_PROXY_ALT
|
||||
export https_proxy=$BASH_IT_HTTPS_PROXY_ALT
|
||||
export HTTP_PROXY=$http_proxy
|
||||
export HTTPS_PROXY=$https_proxy
|
||||
export ALL_PROXY=$http_proxy
|
||||
export no_proxy=$BASH_IT_NO_PROXY
|
||||
export NO_PROXY=$no_proxy
|
||||
echo "Enabled alternate proxy environment variables"
|
||||
|
||||
npm-enable-proxy $http_proxy $https_proxy
|
||||
ssh-enable-proxy
|
||||
svn-enable-proxy $http_proxy
|
||||
}
|
||||
|
||||
show-proxy ()
|
||||
{
|
||||
about 'Shows the proxy settings for Bash, Git, npm and SSH'
|
||||
group 'proxy'
|
||||
|
||||
echo ""
|
||||
echo "Environment Variables"
|
||||
echo "====================="
|
||||
env | grep -i "proxy" | grep -v "BASH_IT"
|
||||
|
||||
bash-it-show-proxy
|
||||
npm-show-proxy
|
||||
git-global-show-proxy
|
||||
svn-show-proxy
|
||||
ssh-show-proxy
|
||||
}
|
||||
|
||||
proxy-help ()
|
||||
{
|
||||
about 'Provides an overview of the bash-it proxy configuration'
|
||||
group 'proxy'
|
||||
|
||||
cat << EOF
|
||||
Bash-it provides support for enabling/disabling proxy settings for various shell tools.
|
||||
|
||||
The following backends are currently supported (in addition to the shell's environment variables): Git, SVN, npm, ssh
|
||||
|
||||
Bash-it uses the following variables to set the shell's proxy settings when you call 'enable-proxy'.
|
||||
These variables are best defined in a custom script in bash-it's custom script folder ('$BASH_IT/custom'),
|
||||
e.g. '$BASH_IT/custom/proxy.env.bash'
|
||||
* BASH_IT_HTTP_PROXY and BASH_IT_HTTPS_PROXY: Define the proxy URL to be used, e.g. 'http://localhost:1234'
|
||||
* BASH_IT_NO_PROXY: A comma-separated list of proxy exclusions, e.g. '127.0.0.1,localhost'
|
||||
|
||||
Run 'glossary proxy' to show the available proxy functions with a short description.
|
||||
EOF
|
||||
|
||||
bash-it-show-proxy
|
||||
}
|
||||
|
||||
bash-it-show-proxy ()
|
||||
{
|
||||
about 'Shows the bash-it proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
echo ""
|
||||
echo "bash-it Environment Variables"
|
||||
echo "============================="
|
||||
echo "(These variables will be used to set the proxy when you call 'enable-proxy')"
|
||||
echo ""
|
||||
env | grep -e "BASH_IT.*PROXY"
|
||||
}
|
||||
|
||||
npm-show-proxy ()
|
||||
{
|
||||
about 'Shows the npm proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v npm &> /dev/null) ; then
|
||||
echo ""
|
||||
echo "npm"
|
||||
echo "==="
|
||||
echo "npm HTTP proxy: " `npm config get proxy`
|
||||
echo "npm HTTPS proxy: " `npm config get https-proxy`
|
||||
fi
|
||||
}
|
||||
|
||||
npm-disable-proxy ()
|
||||
{
|
||||
about 'Disables npm proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v npm &> /dev/null) ; then
|
||||
npm config delete proxy
|
||||
npm config delete https-proxy
|
||||
echo "Disabled npm proxy settings"
|
||||
fi
|
||||
}
|
||||
|
||||
npm-enable-proxy ()
|
||||
{
|
||||
about 'Enables npm proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
local my_http_proxy=${1:-$BASH_IT_HTTP_PROXY}
|
||||
local my_https_proxy=${2:-$BASH_IT_HTTPS_PROXY}
|
||||
|
||||
if $(command -v npm &> /dev/null) ; then
|
||||
npm config set proxy $my_http_proxy
|
||||
npm config set https-proxy $my_https_proxy
|
||||
echo "Enabled npm proxy settings"
|
||||
fi
|
||||
}
|
||||
|
||||
git-global-show-proxy ()
|
||||
{
|
||||
about 'Shows global Git proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v git &> /dev/null) ; then
|
||||
echo ""
|
||||
echo "Git (Global Settings)"
|
||||
echo "====================="
|
||||
echo "Git (Global) HTTP proxy: " `git config --global --get http.proxy`
|
||||
echo "Git (Global) HTTPS proxy: " `git config --global --get https.proxy`
|
||||
fi
|
||||
}
|
||||
|
||||
git-global-disable-proxy ()
|
||||
{
|
||||
about 'Disables global Git proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v git &> /dev/null) ; then
|
||||
git config --global --unset-all http.proxy
|
||||
git config --global --unset-all https.proxy
|
||||
echo "Disabled global Git proxy settings"
|
||||
fi
|
||||
}
|
||||
|
||||
git-global-enable-proxy ()
|
||||
{
|
||||
about 'Enables global Git proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v git &> /dev/null) ; then
|
||||
git-global-disable-proxy
|
||||
|
||||
git config --global --add http.proxy $BASH_IT_HTTP_PROXY
|
||||
git config --global --add https.proxy $BASH_IT_HTTPS_PROXY
|
||||
echo "Enabled global Git proxy settings"
|
||||
fi
|
||||
}
|
||||
|
||||
git-show-proxy ()
|
||||
{
|
||||
about 'Shows current Git project proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v git &> /dev/null) ; then
|
||||
echo "Git Project Proxy Settings"
|
||||
echo "====================="
|
||||
echo "Git HTTP proxy: " `git config --get http.proxy`
|
||||
echo "Git HTTPS proxy: " `git config --get https.proxy`
|
||||
fi
|
||||
}
|
||||
|
||||
git-disable-proxy ()
|
||||
{
|
||||
about 'Disables current Git project proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v git &> /dev/null) ; then
|
||||
git config --unset-all http.proxy
|
||||
git config --unset-all https.proxy
|
||||
echo "Disabled Git project proxy settings"
|
||||
fi
|
||||
}
|
||||
|
||||
git-enable-proxy ()
|
||||
{
|
||||
about 'Enables current Git project proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v git &> /dev/null) ; then
|
||||
git-disable-proxy
|
||||
|
||||
git config --add http.proxy $BASH_IT_HTTP_PROXY
|
||||
git config --add https.proxy $BASH_IT_HTTPS_PROXY
|
||||
echo "Enabled Git project proxy settings"
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
svn-show-proxy ()
|
||||
{
|
||||
about 'Shows SVN proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v svn &> /dev/null) && $(command -v python &> /dev/null) ; then
|
||||
echo ""
|
||||
echo "SVN Proxy Settings"
|
||||
echo "=================="
|
||||
python - <<END
|
||||
import ConfigParser, os
|
||||
config = ConfigParser.ConfigParser()
|
||||
config.read(os.path.expanduser('~/.subversion/servers'))
|
||||
if (config.has_section('global')):
|
||||
proxy_host = ''
|
||||
proxy_port = ''
|
||||
proxy_exceptions = ''
|
||||
if (config.has_option('global', 'http-proxy-host')):
|
||||
proxy_host = config.get('global', 'http-proxy-host')
|
||||
if (config.has_option('global', 'http-proxy-port')):
|
||||
proxy_port = config.get('global', 'http-proxy-port')
|
||||
if (config.has_option('global', 'http-proxy-exceptions')):
|
||||
proxy_exceptions = config.get('global', 'http-proxy-exceptions')
|
||||
print 'http-proxy-host : ' + proxy_host
|
||||
print 'http-proxy-port : ' + proxy_port
|
||||
print 'http-proxy-exceptions: ' + proxy_exceptions
|
||||
END
|
||||
fi
|
||||
}
|
||||
|
||||
svn-disable-proxy ()
|
||||
{
|
||||
about 'Disables SVN proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v svn &> /dev/null) && $(command -v python &> /dev/null) ; then
|
||||
python - <<END
|
||||
import ConfigParser, os
|
||||
config = ConfigParser.ConfigParser()
|
||||
config.read(os.path.expanduser('~/.subversion/servers'))
|
||||
if config.has_section('global'):
|
||||
changed = False
|
||||
if config.has_option('global', 'http-proxy-host'):
|
||||
config.remove_option('global', 'http-proxy-host')
|
||||
changed = True
|
||||
if config.has_option('global', 'http-proxy-port'):
|
||||
config.remove_option('global', 'http-proxy-port')
|
||||
changed = True
|
||||
if config.has_option('global', 'http-proxy-exceptions'):
|
||||
config.remove_option('global', 'http-proxy-exceptions')
|
||||
changed = True
|
||||
if changed:
|
||||
with open(os.path.expanduser('~/.subversion/servers'), 'wb') as configfile:
|
||||
config.write(configfile)
|
||||
print 'Disabled SVN proxy settings'
|
||||
END
|
||||
fi
|
||||
}
|
||||
|
||||
svn-enable-proxy ()
|
||||
{
|
||||
about 'Enables SVN proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if $(command -v svn &> /dev/null) && $(command -v python &> /dev/null) ; then
|
||||
local my_http_proxy=${1:-$BASH_IT_HTTP_PROXY}
|
||||
|
||||
python - "$my_http_proxy" "$BASH_IT_NO_PROXY" <<END
|
||||
import ConfigParser, os, sys, urlparse
|
||||
pieces = urlparse.urlparse(sys.argv[1])
|
||||
host = pieces.hostname
|
||||
port = pieces.port
|
||||
exceptions = sys.argv[2]
|
||||
config = ConfigParser.ConfigParser()
|
||||
config.read(os.path.expanduser('~/.subversion/servers'))
|
||||
if not config.has_section('global'):
|
||||
config.add_section('global')
|
||||
if host is not None:
|
||||
config.set('global', 'http-proxy-host', host)
|
||||
else:
|
||||
config.remove_option('global', 'http-proxy-host')
|
||||
if port is not None:
|
||||
config.set('global', 'http-proxy-port', port)
|
||||
else:
|
||||
config.remove_option('global', 'http-proxy-port')
|
||||
if exceptions is not None:
|
||||
config.set('global', 'http-proxy-exceptions', exceptions)
|
||||
else:
|
||||
config.remove_option('global', 'http-proxy-exceptions')
|
||||
with open(os.path.expanduser('~/.subversion/servers'), 'wb') as configfile:
|
||||
config.write(configfile)
|
||||
print 'Enabled SVN proxy settings'
|
||||
END
|
||||
fi
|
||||
}
|
||||
|
||||
ssh-show-proxy ()
|
||||
{
|
||||
about 'Shows SSH config proxy settings (from ~/.ssh/config)'
|
||||
group 'proxy'
|
||||
|
||||
if [ -f ~/.ssh/config ] ; then
|
||||
echo ""
|
||||
echo "SSH Config Enabled in ~/.ssh/config"
|
||||
echo "==================================="
|
||||
awk '
|
||||
$1 == "Host" {
|
||||
host = $2;
|
||||
next;
|
||||
}
|
||||
$1 == "ProxyCommand" {
|
||||
$1 = "";
|
||||
printf "%s\t%s\n", host, $0
|
||||
}
|
||||
' ~/.ssh/config | column -t
|
||||
|
||||
echo ""
|
||||
echo "SSH Config Disabled in ~/.ssh/config"
|
||||
echo "===================================="
|
||||
awk '
|
||||
$1 == "Host" {
|
||||
host = $2;
|
||||
next;
|
||||
}
|
||||
$0 ~ "^#.*ProxyCommand.*" {
|
||||
$1 = "";
|
||||
$2 = "";
|
||||
printf "%s\t%s\n", host, $0
|
||||
}
|
||||
' ~/.ssh/config | column -t
|
||||
fi
|
||||
}
|
||||
|
||||
ssh-disable-proxy ()
|
||||
{
|
||||
about 'Disables SSH config proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if [ -f ~/.ssh/config ] ; then
|
||||
sed -e's/^.*ProxyCommand/# ProxyCommand/' -i "" ~/.ssh/config
|
||||
echo "Disabled SSH config proxy settings"
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
ssh-enable-proxy ()
|
||||
{
|
||||
about 'Enables SSH config proxy settings'
|
||||
group 'proxy'
|
||||
|
||||
if [ -f ~/.ssh/config ] ; then
|
||||
sed -e's/# ProxyCommand/ ProxyCommand/' -i "" ~/.ssh/config
|
||||
echo "Enabled SSH config proxy settings"
|
||||
fi
|
||||
}
|
||||
Loading…
Reference in New Issue