Installation

How to install cfPassphrase varies between CFML engines. The latest download packages for each CFML engine can be found on the project's homepage. Once you have installed cfPassphrase, see Usage section for details on how to use it.

With Lucee and OpenBD a single file can be placed in the relevant directory - this is the same process as for any other extension/plugin, but please briefly check the relevant notes for additional information.

For simplicity the filenames are referred to here without a version - i.e. as cfpassphrase.jar - but the actual filenames do include versions, (e.g. cfpassphrase-v0.1.jar). It is not necessary to rename the JAR file (though you can if you prefer).

When upgrading, any previous JAR files should be removed or disabled to prevent conflicts.

ColdFusion

Adobe ColdFusion does not provide an extension API, so it is not possible to provide the built-in functions, but it is possible to make custom tags act as built-in tags, and to provide a global component (with CF9 and above) for use in cfscript.

Put cfpassphrase.jar in {cfusion}/lib directory.
Put passphrase.cfc in {cfusion}/CustomTag directory to enable the global component.
Put passphrase.cfm in {cfusion}/wwwroot/WEB-INF/cftags directory to enable the tag.
Restart the server.

Notes:

For ColdFusion 9 and below, {cfusion} is simply {install-dir}.
For ColdFusion 10 and above, {cfusion} is {install-dir}/cfusion.
The correct lib directory is the one containing cfusion.jar.

OpenBlueDragon

Put cfpassphrase.jar in {openbd}/webapps/openbd/WEB-INF/lib directory.
Rename the file to openbdplugin-cfpassphrase.jar
Restart the server.

Notes:

The correct lib directory is the one containing OpenBlueDragon.jar.
Older versions of OpenBD may require editing bluedragon.xml to identify the plugin. Check the log file in {openbd}/webapps/openbd/WEB-INF/bluedragon/work to see if the PluginManager is picking up the plugin.

Lucee Extension Bundle

Upload cfpassphrase.lex via the "Applications" section in Lucee Administrator, or place it in {lucee-server}/deploy directory and wait for Lucee to deploy it.

Notes:

If you have non-LEX cfPassphrase v0.1 installed, it may take precedence - remove or disable the previous JAR to avoid this.
The {lucee-server} directory is configurable, but is probably in the base directory of your Lucee setup. If not, check the servlet configuration for a lucee-server-root parameter to see where it is located.

Lucee / Railo

Put cfpassphrase.jar in {railo-lib} directory.
Put cfpassphrase.fld in {railo-server}/context/library/fld directory to enable functions.
Put cfpassphrase.tld in {railo-server}/context/library/tld directory to enable the tag.
Restart the server.

Notes:

Depending on your install method, {railo-lib} is either {install-dir}/lib/ext or just {install-dir}/lib - look for railo.jar to find the right place.
The {railo-server} directory defaults to {railo-lib}/railo but can be configured to another location. Check the servlet configuration for a railo-server-root parameter to see if it has moved.

Coldbox Plugin

The cfPassphrase JAR can be used in the Coldbox Framework, where it works the same way on all CFML engines. It does not need separate installation, and will not conflict if you do have it installed. See the Coldbox Plugin page for details on using it.

Put cfpassphrase.jar in your javaloader lib directory. If you do not have one, you can create a lib directory in the application root.
Configure the setting javaloader_libpath to point to the lib directory. This setting is defined in the config file (which defaults to conf/Coldbox.cfc).
Put Passphrase.cfc in your plugins directory - again, this defaults to being in the application root, but can be re-configured in the config file.
Perform an fwreinit to pick-up the new config.