Skip to content

Commit dab7fdf

Browse files
committed
update deploy and config docs
1 parent 4e7ad69 commit dab7fdf

File tree

2 files changed

+78
-32
lines changed

2 files changed

+78
-32
lines changed

docs/04.guides/12.deploying-lucee-server-apps/page.md

Lines changed: 62 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ related:
77
- running-lucee-system-properties
88
- locking-down-lucee-server
99
- relocating-web-inf
10+
- cookbook-check-for-changes
1011
forceSortOrder: '22'
1112
---
1213

@@ -16,57 +17,92 @@ forceSortOrder: '22'
1617

1718
[[locking-down-your-lucee-stack]]
1819

19-
There is a `/deploy` folder under the `/lucee-server/` folder which can be used to drop in updates to Lucee.
20+
## The deploy folder
2021

21-
The `/deploy` folder is polled every 60 seconds by Lucee's Controller thread. It looks for (`.lex`) file and (`.lco`) files.
22+
There is a `/deploy` folder under the `/lucee-server/` folder which can be used to customize Lucee .
2223

23-
If Lucee finds an extension `.lex` (in the `/deploy` folder), it installs it (copying it to the `/installed` folder, among other things).
24+
The `/deploy` folder is polled on startup and every 60 seconds by Lucee's Controller thread. It looks for `.lex` files (extensions), `.lco` files (lucee updates) and `.json` files for CFconfig snippets.
2425

25-
If Lucee finds a `.lco` jar (in the `/deploy` folder), it copies it to the `/patches` folder, then it forces the engine to reload that core version immediately.
26+
This is the simplest way to configure / install your Lucee instance at startup or on the fly, without needing to restart it.
2627

27-
However, if there is already a newer Lucee core version in the `/patches/` folder, any older version will simply be ignored. In that case, you need to delete any newer `.lco` files from `/patches/` folder beforehand.
28+
### .json - CFConfig.json
2829

29-
`/deploy` is polled every 60 seconds, `/patches` is only checked at startup.
30+
Since Lucee 6.1.1, if Lucee finds a `*.json` (in the `/deploy` folder) it will be automatically imported and applied to your running `CFconfig` configuration. [LDEV-4994](https://luceeserver.atlassian.net/browse/LDEV-4994)
31+
32+
You can also configure Lucee to [[cookbook-check-for-changes|monitor the server's .CFConfig.json file for changes]].
3033

31-
The `/deploy` folder is just a shortcut way to install the `.lco` version into the patches folder of a running Lucee server without needing to restart it.
34+
### .lex - Extensions
3235

33-
The `/patches` folder is where Lucee's core `.lco` jars are kept. When Lucee starts, it determines which `*.lco` in that folder is the latest version and it loads that version.
36+
If Lucee finds an extension `.lex` in the `/deploy` folder, it will be installed (copying it to the `/installed` folder, among other things).
3437

3538
Extensions (`.lex`) can also be dropped in the `/lucee-server/context/extensions/available` folder and they can be installed using environment or JVM arguments without Lucee reaching out to the update provider.
3639

37-
## Firewalled Servers
40+
### .lco - Lucee core updates
3841

39-
`.lco` updates either via the Lucee Admin update page, or by dropping into the `/deploy` folder, may require dynamically downloading any updated jar files from the update server. As such they may fail attempting to download the new files.
42+
If Lucee finds a `.lco` jar in the `/deploy` folder, it copies it to the `/patches` folder, then it forces the engine to reload that core version immediately.
4043

41-
To update firewalled servers, or to upgrade without Lucee downloading bundles (which is slightly slower), do the following
44+
However, if there is already a newer Lucee core version in the `/patches/` folder, any older version will simply be ignored. In that case, you need to delete any newer `.lco` files from `/patches/` folder beforehand.
4245

43-
1. Stop the server
44-
2. Download the (fat) lucee.jar (see below) from [https://download.lucee.org/](https://download.lucee.org/)
45-
3. Delete or change the file extension for the fat jar in the `lucee/lib` folder, i.e `5.4.3.2.jar`
46-
4. Copy the updated `lucee.jar` into that `lucee\lib` folder
47-
5. Start the server
46+
`/deploy` is polled every 60 seconds, `/patches` is only checked at startup.
47+
48+
The `/patches` folder is where Lucee's core `.lco` jars are kept. When Lucee starts, it determines which `*.lco` in that folder is the latest version and it loads that version.
4849

49-
## Lucee Distributions
50+
### Lucee Distributions
5051

5152
available from [https://download.lucee.org/](https://download.lucee.org/)
5253

53-
- **Lucee.jar** (aka the far jar) which includes lucee core and loader, java bundles, the base set of extensions, admin and docs
54+
- **Lucee.jar** (aka the fat jar) which includes Lucee core and loader, java bundles, the standard base set of extensions, admin and docs
5455
- **Lucee-light.jar** which includes the lucee core and loader, java bundles, admin and docs
55-
- **Lucee-zero.jar** which includes just the lucee core and loader, java bundles (since 6.0.0.492)
56-
- **lucee.lco** just the core lucee engine, which can be used to update an existing Lucee installation
56+
- **Lucee-zero.jar** which includes just the Lucee core and loader, java bundles (since 6.0.0.492)
57+
- **lucee.lco** just the core Lucee engine, which can be used to update an existing Lucee installation
5758

58-
## Customized Installs
59+
### Customized Installs
5960

60-
If you want to deploy a very targeted / customised install, start with Light or Zero and optionally add the extension(s) you want to use in the deploy folder, or set `LUCEE_EXTENSIONS` env var
61+
If you want to deploy a very targeted / customised install, start with Light or Zero and optionally add the extension(s) and `CFconfig.json` you required into the deploy folder, or set `LUCEE_EXTENSIONS` env var
6162

62-
## Warming up installs
63+
### Warming up installs
6364

64-
You can pre warm a lucee installation, by setting the env var `LUCEE_ENABLE_WARMUP` to true, when set, Lucee will deploy and then exit
65+
You can pre warm a lucee installation, by setting the env var `LUCEE_ENABLE_WARMUP` to true, when set, Lucee will deploy itself, including processing any files found in the `/deploy` folder and then exit
6566

66-
## Admin and Docs extensions
67+
### Admin and Docs extensions
6768

6869
You will see extensions, Lucee Admin and Lucee Docs, these simply install mappings to make them available. The admin is tightly coupled to the Lucee Version, so they aren't separately deployed
6970

70-
## AWS Lambdas / Serverless
71+
The Lucee Admin can be disabled by setting the env var `LUCEE_ADMIN_ENABLED=false` which is **recommended** for production/internet facing servers
72+
73+
### Console Logging
74+
75+
Since Lucee [6.2.0.310 / LDEV-3420](https://luceeserver.atlassian.net/browse/LDEV-3420), you can override the default logging configuration in `.CFconfig.json`, to redirect all logs to the console, which is very useful, especially with Docker.
76+
77+
Setting the env var `LUCEE_LOGGING_FORCE_APPENDER=console` globally overrides all logging configuration, to log out the console, using the existing configured log levels.
78+
79+
You can override the configured, per log file log levels using the env var `LUCEE_LOGGING_FORCE_LEVEL=INFO`
80+
81+
### Error Templates
82+
83+
By default, Lucee is configured to show detailed error messages, revealing server paths etc, which is great for developing.
84+
85+
This **should be disabled for production servers** by the following `.CFconfig.json` directives, or supply your own templates.
86+
87+
```
88+
{
89+
"errorGeneralTemplate": "/lucee/templates/error/error-public.cfm",
90+
"errorMissingTemplate": "/lucee/templates/error/error-public.cfm"
91+
}
92+
```
93+
94+
### Firewalled Servers
95+
96+
`.lco` updates either via the Lucee Admin update page, or by dropping into the `/deploy` folder, may require dynamically downloading any updated jar files from the update server. As such they may fail attempting to download the new files.
97+
98+
To update firewalled servers, or to upgrade without Lucee downloading bundles (which is slightly slower), do the following
99+
100+
1. Stop the server
101+
2. Download the (fat) lucee.jar (see below) from [https://download.lucee.org/](https://download.lucee.org/)
102+
3. Delete or change the file extension for the fat jar in the `lucee/lib` folder, i.e `5.4.3.2.jar`
103+
4. Copy the updated `lucee.jar` into that `lucee\lib` folder
104+
5. Start the server
105+
106+
### AWS Lambdas / Serverless
71107

72108
[Fuseless: Tools for running Serverless CFML Lambda Functions](https://fuseless.org/)

docs/recipes/check-for-changes.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!--
22
{
3-
"title": "Check for changes",
3+
"title": "Automatic monitoring and applying CFConfig changes",
44
"id": "cookbook-check-for-changes",
55
"description": "Automatically check for changes in your configuration file with Lucee.",
66
"keywords": [
@@ -17,13 +17,21 @@
1717
}
1818
-->
1919

20-
# Check for changes in your configuration file automatically
20+
## Check for changes in your configuration file automatically
2121

2222
Lucee can automatically check for changes in your configuration files from the complete server or a single web context.
2323

2424
This is useful if you are doing scripted deploys and/or synchronization from, for example, a master instance to many slave instances of Lucee.
2525

26-
## Check for Changes in ALL the contexts
26+
### Check for Changes - CFconfig.json (6+)
27+
28+
```
29+
{
30+
"checkForChanges": true
31+
}
32+
```
33+
34+
### Check for Changes in ALL the contexts (pre 6.0)
2735

2836
To enable this for a whole Lucee server, find the Lucee server XML file in:
2937

@@ -37,13 +45,15 @@ Now it's simple to add the following:
3745

3846
<cfLuceeConfiguration hspw="xxx" salt="xx" check-for-changes="true" version="4.2">
3947

48+
### Restart Lucee
49+
4050
Now that you have made the change, you can either restart Lucee server from the administrator at:
4151

4252
http://localhost:8888/lucee/admin/server.cfm?action=services.restart
4353

44-
Or actually make any change in the Server Admin for the configuration to be picked up. This should now allow it to pick up any changes you have written to the lucee-server.xml file.
54+
Or actually make any change in the Server Admin for the configuration to be picked up. This should now allow it to pick up any changes you have written to the `CFconfig.json` / `lucee-server.xml` file.
4555

46-
## Check for changes in an individual context
56+
### Check for changes in an individual context
4757

4858
If you only want an individual context to check for changes, you can do the same configuration but you would have to go to:
4959

@@ -55,4 +65,4 @@ And add the same changes from above:
5565

5666
Lucee will now check for any changes in the Lucee configuration files every minute, and if there is a change, reload it and enable those changes.
5767

58-
A very handy little feature for those automated deployments!
68+
A very handy little feature for those automated deployments and local development!

0 commit comments

Comments
 (0)