Note: This blog post is from 2019. Some content may be outdated--though not necessarily. Same with links and subsequent comments from myself or others. Corrections are welcome, in the comments. And I may revise the content as necessary.Did you know that when you update ColdFusion, there is often a need to also update the web server connector (for IIS and/or Apache)? In this post, I discuss how you can know when to do it (Adobe makes that easier since CF2016), as well as how to do it (also easier since CF2016), and why it's important.
- Knowing when a connector update is needed
- How to apply the connector update, via gui or commandline
- What updating the web server connector actually does
While the update process is indeed simpler since CF2016, I'll note that the technotes for CF2016 and 2018 still don't currently point out the easier process for upgrading, so what I share below may be a big (and nice) surprise even for those who diligently read the update technotes.
Knowing when a connector update is needed
The need to update the connector is a relatively new phenomenon, starting mostly with CF10, with its being the first release where CF was based on Tomcat (and the underlying Tomcat web server connector, which Adobe modifies to support some functionality needed by some CF users). There were rare occasions that the old JRun-based connector needed updating.
And ever since CF10 also introduced the new automated update mechanism (available in the CF Admin or via the command line), each update's technote has indicated whether that update required a connector update, though sometimes one had to read the whole technote to find the wording indicating if a connector update was required.
A problem with that approach (of it being indicated only in the technote of any CF update that required a connector upgrade) is that if you skipped some CF updates, you then needed to know to look at the technote for EACH skipped update, to see if its technote indicated if THAT update required a connector update. Then you could do the connector update after that latest update you did.
Thankfully, since CF2016, Adobe has included a table at the bottom of each update technote indicating which previous updates may have required a connector update. So now one can easily consult that each time (or if you missed it when applying the update, to consider if you now need to update the connector.)
How to apply the connector update, via gui or commandline
First, note that the wsconfig tool can be run either as a GUI or as a commandline tool. Also, there are helper scripts that even make working from the command line easier.
And good news (for those who use the wsconfig GUI) is that in CF2016 and above, it's far simpler to update the connector than it had been with CF11 and 10.
Upgrading connectors via GUI in CF2016 and later
Many may not notice it, but there is a new "upgrade" button in the wsconfig tool UI (to go with the -upgrade option in the wsconfig command-line tool that has long been available). One need merely run the wsconfig UI, choose an existing connector (from the list of them, such as might say localhost:cfusion), and then click "upgrade".
Note that you do need to do that for each connector.
And note that the tool will restart the web server on each upgrade. Sadly, you cannot prevent that web server restart. Indeed, it happens regardless of whether you click the "ok" button on the prompt indicating that, or if try to click the "x" on that prompt window.
Upgrading connectors via commandline
Whether you are working on a headless implementation of CF (no GUI) or just prefer to better automate/script things, note again that you CAN run the upgrade process by using the wsconfig tool from the command line instead. There are actually a couple of options for this.
First, the wsconfig tool itself can be found (as an exe in Windows or script in Linux) in the cfusion/runtime/bin folder (not cfusion/bin). And while you can get help from the tool itself at the command line (using --help), you can also find its args documented here: helpx.adobe.com/coldfusion/configuring-administering/web-server-management.html#Usingthecommandlineinterface.
Second, there are also helper scripts (bat files for Linux, sh files for Linux) that further facilitate performing connector operations, including simply upgrading all connectors. See those in the cfusion/bin/connectors folder (and mentioned only briefly in that last docs page.)
What updating the web server connector actually does
Usually, all the upgrade process will do is update the connector file (isapi_redirect.dll for IIS, or mod_jk.so for Apache), as typically found in the coldfusion config/wsconfig directory and the numbered folder associated with the selected connector (for Apache, the numbered folders may exist elsewhere, as your conf file references to ColdFusion will indicate).
As an aside, you may want to even look at the date of the .dll or .so file, in your connector folder, to see what date it is. This is how you can know if the file is out of date. Again, per the discussion above, many CF updates DO call for an update to the connector. If you have skipped that, you may find that your dll or so file is quite dated, which could be the cause of some problems you experience with CF. For CF2018, as of the current update 6 as I write this post (or CF2016, as of the current update 13), the file should have a Nov 2019 date. If it does not, that's confirmation that you need to update the connector (after applying the latest CF update.)
As a tip, if you do have multiple connectors to update, you could copy this one updated .dll file (for IIS, or .so file for Apache) into the other folders, and then restart the web server to effect the change in all of them. (Technically, the connector update may do more than just change that file, so this work-around should be used with caution.)
Note also that if you may have tweaked your setup to point the web server config at a different location than CF would use by default (as some do with Apache in Linux), you may need to copy the updated connector file to that new location.
Upgrading connectors via GUI for CF11 and 10
As a follow-up to my earlier discussion about how the wsconfig GUI now offers an "upgrade" button, back "in the old days", it was indeed more tedious. You would have had to REMOVE and then RE-ADD the connector (with the wsconfig tool). I discussed that (and the need to update the connector) in a 2013 post, "CF911: Why/when you MUST update the web server connector for ColdFusion 10/11 and may have missed it", and a follow-on post to that.
That process of removing/re-adding the connector was sometimes trivial, but sometimes a nightmare--especially if you had "tuned the connector" settings, or if you had manually tweaked some other aspect of the connector configuration. Those would be lost in the "remove" and you'd have to re-add the settings after the "re-adding".
Sadly, even folks using CF2016 and above don't know about the new upgrade button, so are still removing/re-adding the connector the "old-fashioned way", which is tedious and more error-prone.
This new upgrade button approach should be a great relief for them to learn about. (And I hope Adobe will please improve their ColdFusion update technotes to clarify the availability of this upgrade button for folks.)
If you need help with any of the above, I welcome questions here, of course, but I can also help you do the updates or connector upgrades, or other updates (such as the JVM or FusionReactor) via my short-term remote consulting, with satisfaction guaranteed.
(I wanted to get the info out, especially with the news of today's "preview" of the Nov 2019 CF updates, which include in fact a fix to the web server connector, which would need to be applied using this upgrade feature, after applying the preview update.)
For more content like this from Charlie Arehart:
Need more help with problems?
- Signup to get his blog posts by email:
- Follow his blog RSS feed
- View the rest of his blog posts
- View his blog posts on the Adobe CF portal
- If you may prefer direct help, rather than digging around here/elsewhere or via comments, he can help via his online consulting services
- See that page for more on how he can help a) over the web, safely and securely, b) usually very quickly, c) teaching you along the way, and d) with satisfaction guaranteed