Difference between revisions of "Lucee"
m (→Coming Soon) |
(add troubleshooting tip for Lucee rest not working.) |
||
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | __FORCETOC__ | |
| + | [[File:Luceelogo.png]]<br><br> | ||
| + | [http://lucee.org/ Lucee] is an open-source CFML engine and the successor of Railo. We proudly support Lucee in our environment, and more info about its background and usage is below. | ||
| − | + | ==Background== | |
| + | The Lucee project was forked from Railo 4.2 in January 2015 and is owned by Lucee Association Switzerland. Though development on Railo has halted, Lucee will eventually inherit the enhancements planned for Railo 5. Currently Lucee operates the same as the latest available version of Railo, so you can migrate your Railo codebase to it without any surprises. | ||
| − | *For | + | See these blogs for more info on the switch from Railo to Lucee: |
| − | * | + | *[http://blog.adamcameron.me/2015/01/lucee.html Lucee - Adam Cameron's Dev Blog] |
| + | *[http://www.codersrevolution.com/blog/railo-and-lucee-hunka-hunka-burning-questions Railo and Lucee ... - Coder's Revolution] | ||
| + | |||
| + | ==Usage / Resources== | ||
| + | For information about Lucee please reference [https://bitbucket.org/lucee/lucee/wiki/ the Lucee wiki]. Specifically, the [https://bitbucket.org/lucee/lucee/wiki/Cookbook Lucee Cookbook] has lots of good info about getting started. | ||
| + | |||
| + | If you're new to CFML in general, the following resources will help you get learn the basics: | ||
| + | *[http://www.trycf.com/tutorials TryCF.com Tutorials] | ||
| + | *[http://bittersweetryan.github.io/ColdFusion-Koans/ ColdFusion Koans] | ||
| + | *[https://github.com/cfjedimaster/ColdFusion-UI-the-Right-Way ColdFusion UI the Right Way] | ||
| + | *[https://github.com/daccfml/cfscript/blob/master/cfscript.md CFScript Documentation] | ||
| + | |||
| + | ==How do I access my Lucee Web Administator page?== | ||
| + | The preferred way to access your site's Lucee Web Administrator is by clicking the '''''Web Administrator''''' link within your control panel. Alternatively, you may access it by appending '''''/lucee/admin/web.cfm''''' to the end of your site's domain name or testing URL. | ||
| + | ===I'm redirected to another page on my site when accessing the Lucee Web Administrator=== | ||
| + | If your site uses rewrite rules to make your site's links search-engine-friendly, then you'll need to make a small adjustment to your rewrite rules. Add the following line to your site's ''.htacess'' file to allow your Lucee Web Administrator to load properly: | ||
| + | <syntaxhighlight lang="apache"> | ||
| + | RewriteEngine On | ||
| + | |||
| + | RewriteCond %{REQUEST_URI} !^.*/(lucee)($|/.*$) [NC] | ||
| + | RewriteRule ^(.*)$ - [NC,L] | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | That code will tell the rewrite engine to ignore requests that contain the word ''lucee''. If your site already has a similar ''RewriteCond'' in its .htacess file ''(common with CF Wheels or ColdBox)'', then just add ''lucee'' to the list of URIs to bypass. | ||
| + | |||
| + | ==How do I create a datasource within Lucee?== | ||
| + | You may create Lucee datasources (DSNs) either withing your site's Lucee Web Administrator or within the site's Application.cfc. More info on creating Lucee datasources is in this Lucee Cookbook entry: [https://bitbucket.org/lucee/lucee/wiki/Cookbook_Datasource_Define_Datasource How to define a Datasource] | ||
| + | |||
| + | ==How do I apply updates to Lucee?== | ||
| + | On a VPS you would apply updates to Lucee through your Lucee Server Administrator. This can be accessed via the shortcut on your server's desktop (Windows), or by visiting http://ServerIP/lucee/admin/server.cfm. ''(replace '''ServerIP''' with your server's public IP address)'' | ||
| + | |||
| + | *Once logged-in, click the '''Update''' link under '''Services'''. | ||
| + | *If an update is available, it will be displayed under the ''Info'' section of that page. | ||
| + | *To apply the update, scroll to the bottom of the page and click the '''Execute Update''' button. | ||
| + | **Once finished, you will be logged-out of the Lucee Server Administrator. | ||
| + | **Once you log-in again, you should see the new version number listed. | ||
| + | |||
| + | If the update breaks part of your site, you can remove it from within the '''Services-->Update''' page as well. Just scroll to the bottom of that page and click the '''Remove Latest Patch''' button. | ||
| + | |||
| + | ==Troubleshooting Lucee Errors== | ||
| + | ===Lucee Web Admin - The DNS for this domain is not pointed to this server=== | ||
| + | '''Error:''' <br> | ||
| + | When accessing the Lucee Web Admin via the cPanel plugin, you receive this error: | ||
| + | The DNS for this domain is not pointed to this server. Please check the DNS settings to make sure it is pointed to the correct IP. | ||
| + | |||
| + | '''Solution:''' <br> | ||
| + | Wait for a moment then reload the page in your browser. This error happens when your Web Admin takes longer than expected to initialize, but reloading the page will allow the Lucee Web Admin to load as expected. | ||
| + | |||
| + | ===Rest service not working=== | ||
| + | '''Error:''' <br> | ||
| + | no rest service for [PATH_HERE] found | ||
| + | Lucee was recently restarted and the web context for your site has not initialized fully. | ||
| + | |||
| + | '''Solution:''' <br> | ||
| + | Browse to a page that is not part of the rest service and it will kick start the web context creation. Afterward, you should be able to use your rest service. | ||
Latest revision as of 23:33, 22 November 2015
Lucee is an open-source CFML engine and the successor of Railo. We proudly support Lucee in our environment, and more info about its background and usage is below.
Contents
Background
The Lucee project was forked from Railo 4.2 in January 2015 and is owned by Lucee Association Switzerland. Though development on Railo has halted, Lucee will eventually inherit the enhancements planned for Railo 5. Currently Lucee operates the same as the latest available version of Railo, so you can migrate your Railo codebase to it without any surprises.
See these blogs for more info on the switch from Railo to Lucee:
Usage / Resources
For information about Lucee please reference the Lucee wiki. Specifically, the Lucee Cookbook has lots of good info about getting started.
If you're new to CFML in general, the following resources will help you get learn the basics:
How do I access my Lucee Web Administator page?
The preferred way to access your site's Lucee Web Administrator is by clicking the Web Administrator link within your control panel. Alternatively, you may access it by appending /lucee/admin/web.cfm to the end of your site's domain name or testing URL.
I'm redirected to another page on my site when accessing the Lucee Web Administrator
If your site uses rewrite rules to make your site's links search-engine-friendly, then you'll need to make a small adjustment to your rewrite rules. Add the following line to your site's .htacess file to allow your Lucee Web Administrator to load properly:
RewriteEngine On RewriteCond %{REQUEST_URI} !^.*/(lucee)($|/.*$) [NC] RewriteRule ^(.*)$ - [NC,L]
That code will tell the rewrite engine to ignore requests that contain the word lucee. If your site already has a similar RewriteCond in its .htacess file (common with CF Wheels or ColdBox), then just add lucee to the list of URIs to bypass.
How do I create a datasource within Lucee?
You may create Lucee datasources (DSNs) either withing your site's Lucee Web Administrator or within the site's Application.cfc. More info on creating Lucee datasources is in this Lucee Cookbook entry: How to define a Datasource
How do I apply updates to Lucee?
On a VPS you would apply updates to Lucee through your Lucee Server Administrator. This can be accessed via the shortcut on your server's desktop (Windows), or by visiting http://ServerIP/lucee/admin/server.cfm. (replace ServerIP with your server's public IP address)
- Once logged-in, click the Update link under Services.
- If an update is available, it will be displayed under the Info section of that page.
- To apply the update, scroll to the bottom of the page and click the Execute Update button.
- Once finished, you will be logged-out of the Lucee Server Administrator.
- Once you log-in again, you should see the new version number listed.
If the update breaks part of your site, you can remove it from within the Services-->Update page as well. Just scroll to the bottom of that page and click the Remove Latest Patch button.
Troubleshooting Lucee Errors
Lucee Web Admin - The DNS for this domain is not pointed to this server
Error:
When accessing the Lucee Web Admin via the cPanel plugin, you receive this error:
The DNS for this domain is not pointed to this server. Please check the DNS settings to make sure it is pointed to the correct IP.
Solution:
Wait for a moment then reload the page in your browser. This error happens when your Web Admin takes longer than expected to initialize, but reloading the page will allow the Lucee Web Admin to load as expected.
Rest service not working
Error:
no rest service for [PATH_HERE] found
Lucee was recently restarted and the web context for your site has not initialized fully.
Solution:
Browse to a page that is not part of the rest service and it will kick start the web context creation. Afterward, you should be able to use your rest service.