Cycle 2.17 Proxy Aware Authentication
Beginning with Cycle 2.17, there is additional functionality within Cycle to handle authentication issues when using Cycle behind a web proxy.
Certain network configurations exist that prevent Cycle from being able to successfully communicate with our authentication server to secure a token. A new, optional authentication method is available starting with Cycle 2.17 that allows Cycle to successfully secure tokens while operating behind a web proxy.
Cycle has 2 processes that need to be made proxy aware by different means. The steps for setting the web proxy configuration for those processes as well how to enable the new authentication implementation are listed below:
Step 1: Set Java Process Web Proxy Configuration
The Cycle Java process is made proxy aware by editing an entry in a JSON configuration file used by the Cycle application. This is the same file that will be edited in step 2 below.
The file location is C:\Users\<Windows User>\AppData\Roaming\cycle-client\uisettings.json
The Java process is made proxy aware by updating the JVMArgs property with your web proxy settings.
Open the uisettings.json file and enter the parameters below into the "JVMArgs" value:
"-Dhttps.proxyHost=[proxy server IP] -Dhttps.proxyPort=[proxy server port] -Dhttps.nonProxyHosts=localhost"
** Note: You must replace the proxyHost and proxyPort values with the proxy server IP address and proxy server port relevant to your network. Please get this information from your organization's network team.**
Here is an example of what the parameters might look like (note: your proxy server IP and proxy server port will be different than the example below)
"-Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttps.nonProxyHosts=localhost"
Save your ui.settings.json file after entering the JVMArgs value. The entry in your file will look similar to the entry below:
If you are using Cycle in an unattended testing pipeline, you will need to set your JETVMPROP environment variable as detailed in the Knowledge Base article linked here: https://help.cyclelabs.io/portal/en/kb/articles/how-to-make-cycle-proxy-aware
Step 2: Enable the New Web Proxy Authentication Method
The new authentication method is enabled by making an entry in a JSON configuration file used by the Cycle application. This is the same file that was edited in step 1 above.
The file location is C:\Users\<Windows User>\AppData\Roaming\cycle-client\uisettings.json
The new method is enabled by adding an the additional key:value pair copied below to the JSON file:
"authImplementation": "cycle-cli"
Open the uisettings.json file in a text editor, add the key:value pair above to the file, then save the updated file.
Here is an example of what the setting will look like in your uisettings.json file:
Step 3: Set the Cycle Go Process Web Proxy Configuration
The Cycle Go process is made proxy aware via a configuration file.
The configuration file is located at C:/Users/<Windows User>/AppData/Roaming/Cycle/config/.env
If the .env file does not exist, Cycle will create it when you launch the application.
The format of the file is a list of key=value entries, each on its own line. Comments start with the # character.
Below is an example of entries for configuring Cycle to use a web proxy:
Please note, you will need to update the server and port information for the HTTP_PROXY and HTTPS_PROXY values that correspond to the web proxy information used by your organization. You may need to contact your organizations network security team to get the appropriate values if you do not already have that information.
Open the .env file with a text editor and populate it with your web proxy information then save the updated .env file.
Your updated .env file will look similar to the example below:
Related Articles
How to Make Cycle Proxy Aware
Certain firewall or proxy configurations may possibly prevent the Cycle authentication process from working properly, and Cycle will not be able to secure an access token. The purpose of this article is to describe the process for making Cycle proxy ...Addressing Cycle 2 Authentication Issues Caused by Network Configuration
Problem The Cycle login process uses the Cycle Labs Azure B2C instance to complete the authentication process and grant an access token for using Cycle. If the machine Cycle is installed on is behind a firewall or proxy, Cycle may not be able to ...Cycle 2 Install Guide
This article covers the process of installing the Cycle Client on your device and the steps required to authenticate using your Cycle Cloud credentials. The release of Cycle 2.9 kicked off our incremental move toward the cloud, leveraging more modern ...Cycle 2 Install FAQ
The Cycle install process and post-install authentication process has changed as of the release of Cycle 2.9.2. This process applies to Cycle 2.9.2 and all future versions of the Cycle 2 Application. This article contains frequently asked questions ...How to resolve "Windows Protected Your PC" message when installing Cycle
Occasionally, when first running the Cycle installer, the following error message may be encountered. To resolve this issue, simply click on the "More info" link. That will display more information about the app that is being prevented from starting. ...