Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/lucee/lucee-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@michaeloffner
michaeloffner committed Sep 17, 2024
2 parents 777fbb2 + c961246 commit d0d94c3
Show file tree
Hide file tree
Showing 6 changed files with 136 additions and 102 deletions.
2 changes: 2 additions & 0 deletions docs/03.reference/02.tags/abort/tag.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ Stops processing of a page at the tag location.
CFML returns everything that was processed before the cfabort tag.

The cfabort tag is often used with conditional logic to stop processing a page when a condition occurs.

Requests that are terminated with cfabort call the Application.cfc onAbort() method instead of the onRequestEnd().
160 changes: 80 additions & 80 deletions docs/04.guides/02.installing-lucee/01.download-and-install/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,75 +109,75 @@ For further information, please refer to <a href="https://tomcat.apache.org/tomc
</thead>
<tbody>

<tr>
<td>
<div class="attribute">Description:</div>
</td>
<td>
<strong>Lucee Installer</strong> is the recommended "all in one" solution for a typical production installation with minimal manual configuration, including service and connectors for fronted webservers ( Apache on Linux / IIS on Windows ). It installs its own dedicated Java Development Kit (AdoptOpenJDK) and comes with the option to install "mod_cfml" for Tomcat's automatic multiple website configuration.
</td>
</tr>
<tr>
<td>
<div class="attribute">OS:</div>
</td>
<td>
Windows, Linux
</td>
</tr>
<tr>
<td>
<div class="attribute">Download:</div>
</td>
<td>
Download the latest <strong>Lucee Installer</strong> Release version <a href="https://lucee.org/downloads.html">here</a>.
</td>
</tr>
<tr>
<td>
<div class="attribute">Includes:</div>
</td>
<td>
<strong>Lucee Installer</strong> ships:<br>
- Lucee.jar (Servlet Container)<br>
- Tomcat (Java Servlet Engine)<br>
- AdoptOpenJDK (Java Development Kit)<br>
- mod_cfml (for Tomcat's automatic host and context configuration - <a href="/guides/installing-lucee/download-and-install.html#mod_cfml">More about mod_cfml</a><br>
- Boncode Connector (for connecting IIS to Tomcat via AJP) - <a href="/guides/installing-lucee/download-and-install.html#BoncodeAJP">More about Boncode</a>
</td>
</tr>
<tr>
<td>
<div class="attribute">Best for:</div>
</td>
<td>
<strong>Lucee Installer</strong> is typically used for production environments where you want have a webserver, e.g. Apache or IIS, acting in front of Lucee/Tomcat and run Lucee as service.
</td>
</tr>
<tr>
<td>
<div class="attribute">Instructions:</div>
</td>
<td>
<strong>On Windows:</strong> Run the Lucee Windows Installer file (.exe) as Administrator on a Windows machine with IIS running, so that the installer can detect IIS and connect it with Lucee/Tomcat (Boncode AJP connector and mod_cfml)<br>
<strong>On Linux:</strong> Run the Lucee Windows Installer file (.run) with sudo user/root on a Linux machine with Apache webserver running, so that the installer can detect Apache and connect it with Lucee/Tomcat (ReverseProxy and mod_cfml). You may need to give the .run file execute permission first to be able to execute it.
</td>
</tr>
<tr>
<td>
<div class="attribute">Description:</div>
</td>
<td>
<strong>Lucee Installer</strong> is the recommended "all in one" solution for a typical production installation with minimal manual configuration, including service and connectors for fronted webservers ( Apache on Linux / IIS on Windows ). It installs its own dedicated Java Development Kit (AdoptOpenJDK) and comes with the option to install "mod_cfml" for Tomcat's automatic multiple website configuration.
</td>
</tr>
<tr>
<td>
<div class="attribute">Note:</div>
</td>
<td>
If you are missing the latest "Lucee Installer" Release at Lucee's download site and it's marked as "Coming soon", you can still install the latest available Lucee version with the following steps:<br>
<strong>Step 1:</strong> Select the latest possible release that has a "Lucee Installer" version available and do the complete installation process.<br>
<strong>Step 2:</strong> Stop the Lucee/Tomcat service.<br>
<strong>Step 3:</strong> Download the latest "Lucee.jar" file at Lucee's download page <a href="https://lucee.org/downloads.html">here</a>.<br>
<strong>Step 4:</strong> Replace the old lucee.jar with the new downloaded Lucee.jar file at <em>path-to-lucee-install/lib/</em>.<br>
<strong>Step 5:</strong> Delete the folder "lucee-server" at <em>path-to-lucee-install/tomcat/lucee-server</em>.<br>
<strong>Step 6:</strong> Restart the Lucee/Tomcat service.
</td>
</tr>
</tbody>
<td>
<div class="attribute">OS:</div>
</td>
<td>
Windows, Linux
</td>
</tr>
<tr>
<td>
<div class="attribute">Download:</div>
</td>
<td>
Download the latest <strong>Lucee Installer</strong> Release version <a href="https://lucee.org/downloads.html">here</a>.
</td>
</tr>
<tr>
<td>
<div class="attribute">Includes:</div>
</td>
<td>
<strong>Lucee Installer</strong> ships:<br>
- Lucee.jar (Servlet Container)<br>
- Tomcat (Java Servlet Engine)<br>
- AdoptOpenJDK (Java Development Kit)<br>
- mod_cfml (for Tomcat's automatic host and context configuration - <a href="/guides/installing-lucee/download-and-install.html#mod_cfml">More about mod_cfml</a><br>
- Boncode Connector (for connecting IIS to Tomcat via AJP) - <a href="/guides/installing-lucee/download-and-install.html#BoncodeAJP">More about Boncode</a>
</td>
</tr>
<tr>
<td>
<div class="attribute">Best for:</div>
</td>
<td>
<strong>Lucee Installer</strong> is typically used for production environments where you want have a webserver, e.g. Apache or IIS, acting in front of Lucee/Tomcat and run Lucee as service.
</td>
</tr>
<tr>
<td>
<div class="attribute">Instructions:</div>
</td>
<td>
<strong>On Windows:</strong> Run the Lucee Windows Installer file (.exe) as Administrator on a Windows machine with IIS running, so that the installer can detect IIS and connect it with Lucee/Tomcat (Boncode AJP connector and mod_cfml)<br>
<strong>On Linux:</strong> Run the Lucee Windows Installer file (.run) with sudo user/root on a Linux machine with Apache webserver running, so that the installer can detect Apache and connect it with Lucee/Tomcat (ReverseProxy and mod_cfml). You may need to give the .run file execute permission first to be able to execute it.
</td>
</tr>
<tr>
<td>
<div class="attribute">Note:</div>
</td>
<td>
If you are missing the latest "Lucee Installer" Release at Lucee's download site and it's marked as "Coming soon", you can still install the latest available Lucee version with the following steps:<br>
<strong>Step 1:</strong> Select the latest possible release that has a "Lucee Installer" version available and do the complete installation process.<br>
<strong>Step 2:</strong> Stop the Lucee/Tomcat service.<br>
<strong>Step 3:</strong> Download the latest "Lucee.jar" file at Lucee's download page <a href="https://lucee.org/downloads.html">here</a>.<br>
<strong>Step 4:</strong> Replace the old lucee.jar with the new downloaded Lucee.jar file at <em>path-to-lucee-install/lib/</em>.<br>
<strong>Step 5:</strong> Delete the folder "lucee-server" at <em>path-to-lucee-install/tomcat/lucee-server</em>.<br>
<strong>Step 6:</strong> Restart the Lucee/Tomcat service.
</td>
</tr>
</tbody>
</table>
</div>
<br>
Expand All @@ -191,12 +191,12 @@ For further information, please refer to <a href="https://tomcat.apache.org/tomc
</thead>
<tbody>

<tr>
<td>
<div class="attribute">Description:</div>
</td>
<td>
<strong>CommandBox</strong> is a commandline tool that greatly simplifies installing and running Lucee. It's very likely the easiest way to run Lucee: Simply open a terminal session from within your webroot, enter the command line 'box server start' and CommandBox will start the latest stable Lucee instance running your web application.<br>
<tr>
<td>
<div class="attribute">Description:</div>
</td>
<td>
<strong>CommandBox</strong> is a commandline tool that greatly simplifies installing and running Lucee. It's very likely the easiest way to run Lucee: Simply open a terminal session from within your webroot, enter the command line 'box server start' and CommandBox will start the latest stable Lucee instance running your web application.<br>
CommandBox makes use of it's
own servlet engine "Undertow" that can be customized through a single .json configuration file. But that's not all you get with CommandBox: Because CommandBox is also a package manager, you can also install and run usefool tools for your CFML development, such as "cfconfig", "CFLint", "taskRunner", "testBox", "CFFormat" or use it to install popular CFML frameworks in a modern scaffolding manner.
</td>
Expand Down Expand Up @@ -247,12 +247,12 @@ For further information, please refer to <a href="https://tomcat.apache.org/tomc
</thead>
<tbody>

<tr>
<td>
<div class="attribute">Description:</div>
</td>
<td>
<strong>Lucee.jar</strong> is the pure stand alone servlet containers of Lucee as compressed Java ARchive (also known as JAR-file) and <strong>Lucee.war</strong> is a Web application ARchive (also known as WAR-file) containing the Lucee.jar. Use these files if you want to run Lucee in different environments with different servlet engines (e.g. Undertow, Jetty or cloud based servlet engines like AWSElasticBeanstalk).
<tr>
<td>
<div class="attribute">Description:</div>
</td>
<td>
<strong>Lucee.jar</strong> is the pure stand alone servlet containers of Lucee as compressed Java ARchive (also known as JAR-file) and <strong>Lucee.war</strong> is a Web application ARchive (also known as WAR-file) containing the Lucee.jar. Use these files if you want to run Lucee in different environments with different servlet engines (e.g. Undertow, Jetty or cloud based servlet engines like AWSElasticBeanstalk).
<br>
You may also use Lucee.jar for upgrading/downgrading Lucee installations without a complete re-installation by simply replacing the .jar file in the servlets engine library folder. If so, please make always sure to backup Tomcat, all server- and web-contexts and your configurations before upgrading.
</td>
Expand Down
44 changes: 22 additions & 22 deletions docs/04.guides/11.developing-with-lucee-server/05.scope/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,25 @@ menuTitle: Scopes

These scopes are not necessarily available between components in the same request -- in other words elements or variables in these scopes may be "out of scope" if set in one module and referred to in another.

Scope | Description | Notes |
------------------------ | -------------------------
arguments | Holds arguments that are passed to a function or CFC method | |
attributes | Contains attributes that are passed to a custom tag | |
caller | Refers to the scope of the calling page when a custom tag or module is called | |
this | The public scope for a Component/CFC | |
thread | The scope within a thread | |
variables | The private scope for a Component/CFC | |
| Scope | Description | Notes |
| ---------- | -------------------------------------------------------------------------------- | ----- |
| arguments | Holds arguments that are passed to a function or CFC method | |
| attributes | Contains attributes that are passed to a custom tag | |
| caller | Refers to the scope of the calling page when a custom tag or module is called | |
| this | The public scope for a Component/CFC | |
| thread | The scope within a thread | |
| variables | The private scope for a Component/CFC | |

## Request scopes ##

These scopes persist through a single request, i.e. any code, in any module, can refer to these scopes during the life of the request:

Scope | Description | Notes |
------------------------ | -------------------------
form | Contains arguments that are received from HTML POST operations, i.e. usually form data | Lucee has an option to merge form and URL scopes. If this option is enabled, both scopes will contain the same items. |
cgi | Holds environment variables generated by the web server. | CGI variables will vary according to server platform in use and browser. |
request | Used to store data across an entire request. Data put into the request scope will be accessible from all templates, CFCs, custom tags, etc | |
url | | |
| Scope | Description | Notes |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
| form | Contains arguments that are received from HTML POST operations, i.e. usually form data | Lucee has an option to merge form and URL scopes. If this option is enabled, both scopes will contain the same items. |
| cgi | Holds environment variables generated by the web server. | CGI variables will vary according to server platform in use and browser. | |
| request | Used to store data across an entire request. Data put into the request scope will be accessible from all templates, CFCs, custom tags, etc | |
| url | | |

## Query scopes ##

Expand All @@ -45,14 +45,14 @@ This (slow) lookup can be disabled (for better performance) in the Lucee admin o

These scopes persist between requests, i.e. a value can be set during one request then retrieved in a subsequent one:

Scope | Description | Notes |
------------------------ | -------------------------
application| Holds elements that relate to the application as a whole. | |
client | Contains elements that persist indefinitely for this particular client (browser).| |
cookie | Refers to the scope of the calling page when a custom tag or module is called | |
server | Used to store data that is accessible from any application on a particular server.| |
session | Holds data pertaining to the user's session. | |
cluster | | Deprecated |
| Scope | Description | Notes |
| ----------- | ---------------------------------------------------------------------------------- | ---------- |
| application | Holds elements that relate to the application as a whole. | |
| client | Contains elements that persist indefinitely for this particular client (browser). | |
| cookie | Refers to the scope of the calling page when a custom tag or module is called | |
| server | Used to store data that is accessible from any application on a particular server. | |
| session | Holds data pertaining to the user's session. | |
| cluster | | Deprecated |

## What scope should I use in...? ##

Expand Down
14 changes: 14 additions & 0 deletions docs/04.guides/12.deploying-lucee-server-apps/02.lockdown-guide/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ A guide to limit access to a Lucee server to necessary minimum.

On Windows it is recommended to run the Lucee/Tomcat service as a restricted user with only the required permissions rather than under SYSTEM account.

## Production Error Templates ##

By default, Lucee ships with developer friendly error templates which reveal the Lucee version and displays stacktraces, including paths.

Production servers, should be configured to use the `error-public.cfm` templates, for both Error and Missing templates, which only display a generic error message.
This can be configured via the Lucee Administrator, under Settings -- Error, which produces the following `.CFconfig.json` config. You can also use your own custom templates.

```
{
"errorGeneralTemplate": "/lucee/templates/error/error-public.cfm",
"errorMissingTemplate": "/lucee/templates/error/error-public.cfm"
}
```

### Don't forget to lockdown your source control metadata ###

If you have .git folders (or .svn etc) make sure you restrict access to them (i.e for Apache)
Expand Down
4 changes: 4 additions & 0 deletions docs/recipes/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,10 @@ Learn about the changes in Lucee 6.1 regarding Monitoring and Debugging. Underst

Shows you a way to enable Monitoring for your session

## [New Operator in Lucee](/docs/recipes/new-operator.md)

This document provides a guide on using the new operator in Lucee for creating instances of CFML components and Java classes.

## [Null Support](/docs/recipes/null-support.md)

This document explains how to set null support in the Lucee server admin, assigning `null` value for a variable and how to use `null` and `nullvalue`.
Expand Down
14 changes: 14 additions & 0 deletions docs/recipes/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -632,6 +632,20 @@
"session"
]
},
{
"file": "new-operator.md",
"title": "New Operator in Lucee",
"path": "/docs/recipes/new-operator.md",
"hash": "011473bdfa41fc6e27523f81b3d8c7d9",
"keywords": [
"new",
"java",
"classes",
"class",
"createObject",
"component"
]
},
{
"file": "null-support.md",
"title": "Null Support",
Expand Down

0 comments on commit d0d94c3

Please sign in to comment.