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/recipes/configuration.md
+30-25Lines changed: 30 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@
11
11
],
12
12
"related": [
13
13
"function-configimport",
14
+
"function-configtranslate",
14
15
"tag-application",
15
16
"maven"
16
17
]
@@ -21,18 +22,22 @@
21
22
22
23
This guide outlines best practices for configuring Lucee across different environments. While Lucee includes an
23
24
administrator frontend (`<your-website>/lucee/admin.cfm`), this guide focuses on configuring Lucee using
24
-
environment variables, configuration files, and `Application.cfc`.
25
+
environment variables, configuration files, and `Application.cfc`.
25
26
26
-
The goal is to explore various configuration possibilities rather than providing one definitive approach.
27
+
The goal is to explore various configuration possibilities rather than providing one definitive approach.
27
28
28
-
Since Lucee 6, configuration has shifted to JSON files (`.CFConfig.json`), replacing the older XML-based configurations.
29
+
Since Lucee 6, configuration has shifted to JSON files (`.CFConfig.json`), replacing the older XML-based configurations.
30
+
31
+
The [[function-configtranslate]] function can be used to translate an Lucee 5 style `lucee-server.xml` or `lucee-web.xml.cfm` file to `CFConfig.json`.
32
+
33
+
Lucee will automatically perform this translation if you upgrade a Lucee 5 instance to 6, this will only happen when there is no `CFConfig.json` file but an `.xml` is found.
29
34
30
35
This guide focuses on Lucee 6 and onwards.
31
36
32
37
## Single Mode vs Multi Mode
33
38
34
39
Lucee runs within a Servlet Engine (such as Tomcat), allowing you to manage multiple websites (or web contexts)
35
-
within a single engine.
40
+
within a single engine.
36
41
37
42
For example, you can host `lucee.org` and `whatever.org` on one Servlet Engine, each
38
43
in its own web context.
@@ -54,9 +59,9 @@ by providing just one server configuration. Lucee 7 will exclusively support sin
54
59
-**New Installations**: Lucee will run in single mode by default.
55
60
56
61
You can toggle between "multi" and "single" modes using the Lucee administrator or by adjusting the server
57
-
configuration file (`.CFConfig.json`).
62
+
configuration file (`.CFConfig.json`).
58
63
59
-
In the administrator, you can merge all the settings from web contexts into a single server configuration.
64
+
In the administrator, you can merge all the settings from web contexts into a single server configuration.
60
65
61
66
Simply switching the mode flag without merging will result in losing web context configurations (though Lucee keeps them in place).
62
67
@@ -118,7 +123,7 @@ The location of the `lucee-server` directory can be customized using the `LUCEE_
118
123
variable or the `-Dlucee.server.dir` system property.
119
124
120
125
At startup, Lucee reads this configuration, applying the settings and resolving resources (e.g., extensions,
121
-
[[maven|Maven endpoints]], etc.).
126
+
[[maven|Maven endpoints]], etc.).
122
127
123
128
A good approach is to configure Lucee through the administrator, then take the resulting `.CFConfig.json` file as a base for future installations / dpeloyments.
0 commit comments