AWS amazonq documentation change
Summary
Added proxy configuration documentation including authentication and SOCKS proxy support for enterprise environments
Security assessment
The change adds security-adjacent documentation about secure proxy configuration and credential handling, but does not address a specific security vulnerability. It improves documentation around secure network configurations without evidence of fixing an existing security issue.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/command-line-installing.md b/amazonq/latest/qdeveloper-ug/command-line-installing.md index 51238acca..53f400864 100644 --- a//amazonq/latest/qdeveloper-ug/command-line-installing.md +++ b//amazonq/latest/qdeveloper-ug/command-line-installing.md @@ -5 +5 @@ -macOSLinux AppImageUbuntuHomebrewUninstallingDebugging +macOSLinux AppImageUbuntuHomebrewProxy configurationUninstallingDebugging @@ -11 +11 @@ You can install Amazon Q for command line for macOS by initiating a file downloa -There are two modalities to consider when installing Amazon Q for command line. Minimal installation only distributes the binaries needed on Linux for Amazon Q chat and for the autocomplete feature to function over SSH (`q` and `qterm`). Full distribution contains the desktop application and requires the autocomplete feature to be used. If you want to only use the Amazon Q chat, consider that the minimal distribution also ships and installs `qterm` to your shell. You can use `qterm` for zsh to support inline completions and a full version isn't required. For more information, see [Installing with a zip file](./command-line-installing-ssh-setup-autocomplete.html) . +There are two installation options to consider when installing Amazon Q for command line. The minimal installation includes only the binaries needed on Linux for Amazon Q chat and for the autocomplete feature to function over SSH (`q` and `qterm`). The full installation contains the desktop application and requires the autocomplete feature to be used. If you want to only use the Amazon Q chat, consider that the minimal installation also ships and installs `qterm` to your shell. You can use `qterm` for zsh to support inline completions and a full version isn't required. For more information, see [Installing with a zip file](./command-line-installing-ssh-setup-autocomplete.html). @@ -23 +23 @@ After installing Amazon Q for command line for macOS, you can enable SSH integra -**To install Amazon Q for command line for macOS** +To install Amazon Q for command line for macOS, complete the following procedure. @@ -39 +39 @@ After installing Amazon Q for command line for macOS, you can enable SSH integra - + @@ -52 +52 @@ You can install Amazon Q for command line for Linux using the AppImage format, w -**To install Amazon Q for command line for Linux using AppImage** +To install Amazon Q for command line for Linux using AppImage, complete the following procedure. @@ -77 +77 @@ You can install Amazon Q for command line for Ubuntu using the .deb package. -**To install Amazon Q for command line for Ubuntu** +To install Amazon Q for command line for Ubuntu, complete the following procedure. @@ -99 +99 @@ You can install Amazon Q for command line for Ubuntu using the .deb package. -**To install Amazon Q Developer CLI with Homebrew** +To install Amazon Q Developer CLI with Homebrew, run the following command: @@ -103,0 +104,56 @@ You can install Amazon Q for command line for Ubuntu using the .deb package. +## Proxy configuration + +Amazon Q Developer CLI (v1.8.0 and later) supports proxy servers commonly used in enterprise environments. The CLI automatically respects standard proxy environment variables. + +### Setting proxy environment variables + +Configure proxy settings by setting these environment variables in your shell: + + + # HTTP proxy for non-SSL traffic + export HTTP_PROXY=http://proxy.company.com:8080 + + # HTTPS proxy for SSL traffic + export HTTPS_PROXY=http://proxy.company.com:8080 + + # Bypass proxy for specific domains + export NO_PROXY=localhost,127.0.0.1,.company.com + +### Proxy with authentication + +For proxies requiring authentication: + + + export HTTP_PROXY=http://username:[email protected]:8080 + export HTTPS_PROXY=http://username:[email protected]:8080 + +### SOCKS proxy support + +Amazon Q CLI also supports SOCKS proxies: + + + export HTTP_PROXY=socks5://proxy.company.com:1080 + export HTTPS_PROXY=socks5://proxy.company.com:1080 + +### Verifying proxy configuration + +After setting proxy environment variables, test connectivity: + + + q doctor + +### Troubleshooting proxy issues + +If you encounter proxy-related connection issues: + + * Verify proxy server accessibility and credentials + + * Ensure your corporate firewall allows connections to AWS endpoints + + * Contact your IT administrator if SSL certificate validation fails + + * Check that the proxy server supports the required protocols + + + + @@ -108 +164 @@ You can uninstall Amazon Q for command line if you no longer need it. -**To uninstall Amazon Q for command line on macOS** +To uninstall Amazon Q for command line on macOS, complete the following procedure. @@ -121 +177 @@ You can uninstall Amazon Q for command line if you no longer need it. -**To uninstall Amazon Q for command line on Ubuntu** +To uninstall Amazon Q for command line on Ubuntu, complete the following procedure.