Lucee Configuration

You can access the console from any machine, by default.  Accessing the console depends on how you access the intranet.  

• If you use intranet.mycompany.com to access the intranet, your URL for the console needs to be either HTTP://intranet.mycompany.com/railo-context/admin/web.cfm or HTTP://intranet.mycompany.com/lucee/admin/web.cfm
• If you use mycompany.com/intranet to access the intranet, your URL for the console needs to be either  HTTP://mycompany.com/railo-context/admin/web.cfm or HTTP://mycompany.com/lucee/admin/web.cfm

The Web Administrator defines local Settings for a web and the Server Administrator the global default values. In the Server Administrator global services like mappings, customtags, datasources etc. can be defined globally so that all webs have access to them. In the local Web Administrators global services can’t be deleted, they are read only. In terms of Lucee and Railo, a web is similar to a webroot directory. Each Lucee or Railo web contains its own WEB-INF directory in which all individual web settings are stored. Every web has its own lucee-web.xml or railo-web.xml file which contains all administrator settings for this particular web. Lucee and Railo are able to separate webs logically. This means that you have your own local web administrator for each of the Lucee or Railo webs. With the help of this web administrator you can set up different datasources, mappings, debug-settings etc. for each individual web. And they can differ from web to web.

If you need to access the server configuration console, you can click the server tab after using the correct URL as noted above, or you can replace web.cfm with server.cfm in the URL.

Certificates are the only item that is installed and configured on the Server Console.

1. Log into the Server tab of the console and click on SSL Certificates under Services
2. Enter the host name the certificate is assigned to
3. Click list
4. Verify the details shown for the certificate found
5. Click install if the details are accurate
6. Navigate to any other menu item and then back to SSL Certificates to ensure it installed

Mappings are found under Archives and Resources on the left. Create your mapping with the following settings:

• Virtual:  
  • /Intranet (if you have /intranet in your URL)
  • / (if you do not have /intranet in your URL)
• Resource:  C:\inetpub\wwwroot\intranet (or the location of your Intranet folder, if different)
• Archive:  C:\inetpub\wwwroot\intranet\IntranetConnections.ras (or the location of the IntranetConnections.ras file, if different)

If you aren’t sure where your installation is, you can confirm by opening IIS, highlighting your Intranet site, and clicking on Basic Settings on the far right-hand side. That will give you the correct path of where the Intranet is installed (e.g. C:\inetpub\ or C:\sqbox\).

If your path in IIS doesn't include /intranet in the path, then your mapping is ‘/intranet’.  If the path in IIS includes the /Intranet folder, your mapping is ‘/’

If your mapping has anything in red, the path is incorrect.

Datasource is found under Services on the left.

Create your datasource with the following settings:

1. Name:  SQLfunctions
2. Type:  MSSQL  Microsoft SQL Server (Vendor Microsoft)
3. Click create
4. Host/Server:  Enter the hostname of the server your SQL database is installed on
5. Database:  Enter the name of the database; this is typically IntranetConnections
6. Username:  Enter a username with rights to the database; this is typically IntranetConnections
7. Password:  Enter the corresponding password (contact Support for the default password)
8. Click create

The datasource will be verified.  You should see a green ‘OK’ at the end of the line with the datasource listed.  If you don’t, you will see an error.

• If the error refers to an incorrect login, verify the username and password you’ve entered.  You should be able to connect to the database using SQL Management Studio with the credentials entered.
• If the error refers to ‘NetworkIOError’, the port number is incorrect.  To correct this, open SQL Configuration Manager on the SQL server and expand SQL Server Network Configuration
  1. Click protocols for INTRACONNECTIONS
  2. Select TCP/IP then right click and select properties
  3. Click the IP Addresses tab
  4. Scroll to the bottom and your port is listed under TCP Dynamic Ports

Note: If you're connecting to an external database for SQL Query fields, your datasource name, server/host, database name, and port will be different.

Mail is found under Services on the left. To set up a new mapping for the Intranet follow these steps:

1. Create your Mail setting with the following settings:
   • Server (SMTP):  enter the host name or IP address of your SMTP server
   • Port:  Default port is 25
   • Username/Password:  This is only required if your SMTP server requires authentication
   • TLS/SSL:  check if required
2. Click Save

You can view emails that are in the queue to be sent by clicking on Tasks immediately below Mail. Anything in red is a failure and you can click the pencil icon to view the message.

If your email is not sending due to a 30 second timeout, as specified in the error, you can change that setting under Mail.

You can check and change the time zone by accessing the Regional settings. Regional is found under Settings on the left.

The default time zone settings are configured to be the same as the server's time zone; the setting can be changed manually using the Time Zone option.

You can adjust how much memory is allocated to Lucee (Railo), as follows:

1. Ensure that the web server has enough free RAM to adjust the allocation 
   • Check the following location on the webserver for the current usage of the Lucee Memory:
2. Locate Lucee-Tomcat Service Control in your program's menu (Railo-Tomcat Service Control if on Version 13.0.x)
3. Right click Lucee-Tomcat Service Control and select Run as administrator
4. On the Java tab of the Lucee-Tomcat Service Control, set the Initial Memory Pool setting to 1024 (1 GB) and the Maximum Memory Pool setting to 6144 (6 GB)
5. Click Apply
6. On the General tab, click Stop, then Start

Check the version of Lucee at the bottom of the Admin screen in the intranet.  It should read 4.5.5.015 (versions 14.0 and 14.5 only), or 5.3.12.1 (version 15.0 or higher).  If it doesn't, you can log into the server admin page and update Lucee.

Before Proceeding, have a snapshot of your server as we've received the odd report of the Lucee install becoming corrupted.

1. Go to http://YOURSERVERNAME/lucee/admin/server.cfm and log in (reset your password if you have trouble logging in).
2. Click on update under Services on the left menu.
3. If Type is set to Automatic under Custom Update Provider, set to Manual and click 'Update' underneath this setting before proceeding with the update.
4. You should see an update for 4.5.5.015 (versions 14.0 and 14.5 only), or 5.3.12.1 (version 15.0 or higher).
5. Click Execute Update near the bottom of the page to upgrade to the latest.

Video walking through this process:

If your server doesn't have internet access or if you are behind a firewall, you can follow these steps:

Version 14.0 / 14.5:

Download the latest stable patch for Lucee, then follow these steps:

1. Place the patch file downloaded in C:\lucee\lib\lucee-server\patches (default location)
2. Restart the Lucee service on the web server

Version 15.0:

1. Download the latest ".lco" file from the Lucee downloads page.
2. Stop your Lucee Server
3. Copy the downloaded file to "{server-context}/patches" (the server context is normally at "...\sqbox\lucee\tomcat\lucee-server\patches").
4. Restart Lucee.

The patch will automatically install and you will see the correct version at the bottom of the admin screen in the intranet.

For both Lucee and Railo there are separate web admin and server admin passwords. Reset information is based on default file locations when the physical path for the web site in IIS is C:\inetpub\wwwroot.

1. Edit the lucee-web.xml.cfm file stored in the WEBROOT defined folder where the Intranet should reside. An example of a typical path is: C:\inetpub\wwwroot\WEB-INF\lucee\ or C:\sqbox\webroot\Intranet\WEB-INF\lucee\
   • Please note: If you don't have /intranet in the URL, the path is C:\inetpub\wwwroot\Intranet\WEB-INF\lucee
2. Remove the detail inside the quotes shown for ‘hspw’, ‘password’, and ‘salt’
3. Restart the Apache Tomcat / Lucee service
4. Go to the login screen and choose new password.

Example 1:

<cfLuceeConfiguration hspw="8d4753e5a988f9e4c3a09620b3d50af5a6bfae6a90400c8d4f5912345ab22af1" password="61ccf8f0005f956e846bf9634bca275b0f7ac1dc86cde184d2a649a2ed04c2f5" salt="F66A6E52-9B9B-4B22-988A2C65D3E8D20F" version="4.5"><cfabort/>

Example 2:

<cfLuceeConfiguration hspw="5799d69f0b91e9d4937689dbf91fc452bef93420929046e454720df6005af4ed" salt="F5BB1FA0-7EF4-45F2-A411BA8B795AF3AC" version="4.5"><cfabort/>

1. Once logged into the Console, click Datasource under Services
2. Click the pencil icon at the end of the line for SQLFunctions
3. Locate the Host/Server entry
   • If this is ‘localhost’, the database is installed on the web server.
   • You can use the server name or IP address in SQL Management Studio to connect to the database.
   • If you are using SQL Management Studio on the web server, you can use ‘localhost’ to connect.
   • You can log into the database with either the SA account or Windows Authentication.