Installation

Get up and running in seconds!

CommandBox

You can install this extension by adding the extension ID to the lucee-extensions environment variable and restarting the server:

box server set env.LUCEE_EXTENSIONS="D062D72F-F8A2-46F0-8CBC91325B2F067B" && box restart

You can install a specific version by appending a version string to the extension ID:

box server set env.LUCEE_EXTENSIONS="D062D72F-F8A2-46F0-8CBC91325B2F067B;version=6.5.2" && box restart

(For all available version numbers, see our Release History or the GitHub Releases page.)

Running the box server set env.lucee-extensions command will edit your server.json file to look something like this:

server.json

{
    // ...
    "env":{
        "LUCEE_EXTENSIONS":"D062D72F-F8A2-46F0-8CBC91325B2F067B;version=6.5.2"
    }
}

This config instructs Lucee (not CommandBox) to install the Ortus ORM Extension when Lucee starts up.

From the Lucee Server Admin

You can manually install the extension by opening the Lucee server admin page and browsing to Extension > Applications page, where you'll see a "Ortus ORM Extension" option. Clicking this option will open the installation screen, where you can choose any extension version and click "Install" to install from Forgebox.

Direct Download

You can also download a .lex file from our downloads page and upload this through the Lucee Server admin's Applications page.

Don't Forget To Restart!

Whichever method you use to install the extension, we recommend restarting the server after installing.

Via CommandBox:

server restart