Coldbug

A product of Rift Web Design

Copyright 2019-Present

Documentation

Documentation

Requirements

Setup

Web Start

First Project

Java Options

Lucee Express

Command Box

Lucee Standalone

Requirements

Setup

This section covers the setup of Coldbug.

Web Start

         Coldbug uses JNLP / Web Start technology to launch from a browser.

  1. Download the file from the website (https://getcoldbug.com) by clicking “Run Now”. This will download a file named jnlp.cfm.

  1. Navigate to the file from a CLI and launch the web start file.

Note: this requires that Java is accessible from CLI.

Example (Windows 10):

  1. This will install the necessary files and display a Security Prompt. Click “Run” (Do not show this again… is optional).

  1. On supported Operating Systems, this will immediately launch the application in the default web browser. On unsupported systems, navigate to “http://localhost:4567/”

Note: if you receive a message “Only 1 debugging session can be active at a time.”, and no other tabs have this open, refresh the browser window.

First Project

        If this is your first time using the application, you will need to register and get logged in. You should then be on “Projects” screen.

  1. Click on add project. Which takes us into the Project Settings page. Fill in the form, use the below screenshot as a reference. Note: on Linux OS use absolute path, do not use the tilde character in the path, IE ~/Documents should be /myname/Documents. Linux paths are also case sensitive.
  1. The local and remote directories are a mapping for Coldbug to find the files at the specified local location based on the remote directory. IE, if your Project Root is at C:/mylocalproject/, this would be the local directory. If you are debugging a local instance the remote directory would also be C:/mylocalproject/. If debugging a remote instance, it will create the translation from remote to local, so C:/myremoteproject/index.cfm will look for index.cfm in C:/mylocalproject/.
  2. Directory maps should include the “Mappings” of directories found inside of the Lucee admin “Mappings” section. IE, C:/mysharedlibrary maps a virtual directory as /shared. This would need to be added with the local and remote directories to C:/mysharedlibrary. This allows the files to load so breakpoints can be added or the files can be stepped over.

  1. After adding the project you will have a new project in the list.

  1. Open the project and you will not be in the debugger screen.

Java Options

        Java options must be added to the web service before Coldbug can attach to it for debugging. The next subsections will explain how to setup these options for various server types. If your server is not listed, and you need help to get it setup, please send an email to support@getcoldbug.com to request the setup information be added.

The java options that will be used is:

Java Opts: -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=

Example: -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=7999

        Lucee Express

        If you already have lucee express running, skip steps 1 and 2.

  1. Download the Lucee express zip file.
  2. Unzip the file and configure your web instances.
  3. Navigate to the bin directory and find Catalina.bat (Catalina.sh for linux).
  4. From a CLI execute the follow:

./catalina.bat jpda start

  1. Scroll to the top of the window and find the port that was opened for debugging.

Listening for transport dt_socket at address: 8000

  1. Update your project configuration in Coldbug and set the port to this value: 8000.
  2. Save the project.
  3. Open the project.
  4. Click the play button to attach to the server.

        

        Command Box

        If you already have command box running, skip steps 1 and 2.

  1. Download and setup command box with the lucee web service.
  2. Configure your web instances.
  3. Load into box from CLI (this assumes box is part of your PATH):

box

  1. Navigate to your project.

cd C:/webprojects/mytestwebsite

  1. Execute the startup script with java options

 

  1. You can specify the port number in the arguments to match the port number you have added to settings, if it is a port other than 7999 (replace address=[port] in the screenshot above).

        Lucee Installed

TODO