You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/04.guides/12.deploying-lucee-server-apps/page.md
+62-26Lines changed: 62 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ related:
7
7
- running-lucee-system-properties
8
8
- locking-down-lucee-server
9
9
- relocating-web-inf
10
+
- cookbook-check-for-changes
10
11
forceSortOrder: '22'
11
12
---
12
13
@@ -16,57 +17,92 @@ forceSortOrder: '22'
16
17
17
18
[[locking-down-your-lucee-stack]]
18
19
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
20
21
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 .
22
23
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.
24
25
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.
26
27
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
28
29
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]].
30
33
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
32
35
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).
34
37
35
38
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.
36
39
37
-
##Firewalled Servers
40
+
### .lco - Lucee core updates
38
41
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.
40
43
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.
42
45
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.
48
49
49
-
## Lucee Distributions
50
+
###Lucee Distributions
50
51
51
52
available from [https://download.lucee.org/](https://download.lucee.org/)
52
53
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
54
55
-**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
57
58
58
-
## Customized Installs
59
+
###Customized Installs
59
60
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
61
62
62
-
## Warming up installs
63
+
###Warming up installs
63
64
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
65
66
66
-
## Admin and Docs extensions
67
+
###Admin and Docs extensions
67
68
68
69
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
69
70
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.
`.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
71
107
72
108
[Fuseless: Tools for running Serverless CFML Lambda Functions](https://fuseless.org/)
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.
45
55
46
-
## Check for changes in an individual context
56
+
###Check for changes in an individual context
47
57
48
58
If you only want an individual context to check for changes, you can do the same configuration but you would have to go to:
49
59
@@ -55,4 +65,4 @@ And add the same changes from above:
55
65
56
66
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.
57
67
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