From 162ae5fb8428a91b4cad672dce327d521b95f032 Mon Sep 17 00:00:00 2001 From: Charlie Arehart Date: Thu, 23 Feb 2023 17:07:08 -0600 Subject: [PATCH 1/6] Revise discussion of Windows service control Clarified several points, and also tweaked wording and markdown elements. --- .../01.starting-stoping-lucee/page.md | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md index 184e19d1b..c7a80a736 100644 --- a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md +++ b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md @@ -3,20 +3,24 @@ title: Start and Stopping Lucee id: windows-start-stop-lucee --- -There are a couple different methods that allow you to start or stop the Lucee/Tomcat service on a Windows machine. We'll go over them below... +If you run the Lucee installer, it will create a Windows Service and also enable optional control panels based on the Apache Tomcat on which the installer implemented Lucee. There are then a couple different methods to start or stop the Lucee/Tomcat service on a Windows machine. We'll go over these items here. + +While the Tomcat implementation underlying Lucee also offers other ways to start and stop Lucee from the command line (via the lucee\tomcat\bin folder), this documentation is not referring to that. Note also that using that to startup.bat there will NOT use the configuration discussed below regarding the _Lucee-Tomcat Service Control panel_. ### Using Windows Service Controls ### -The Lucee/Tomcat service can be located in your Windows Server Service List and be stopped, started, and otherwise controlled from there: +The Lucee/Tomcat service can be found in the Services control panel, where it can be stopped, started, and otherwise controlled from there. The name of the service may show as "Apache Tomcat 9.0 Lucee", depending on the version of the Lucee installer. + +Note that if you use Windows Task Manager to view services (in its Services tab), Lucee shows by the name "Lucee". (Technically, this Task Manager display shows a service's "Service name" while the Services panel above shows a service's "Display Name", and those can differ.) -### Using the Tomcat Service Control Applet ### +### Using the Lucee-Tomcat Service Control panel ### -The Tomcat Service Control Applet can be found in the Windows Start Menu, and is labeled "Lucee-Tomcat Service Control": +The installer also implements the _Tomcat Service Control_ panel, which can be opened using the Windows _Start_ Menu, where it's found under `Lucee` as the `Lucee-Tomcat Service Control`. -Once launched the Tomcat Service Control Applet will give you the ability to Start and Stop the service, as well as customize the service settings (like JVM params). +Once launched the _Tomcat Service Control_ panel also offers the ability to start and stop the Lucee service, but it can also used to customize the Lucee (Tomcat) service settings (such as JVM params). See the "[Updating Memory Settings](lucee-server-adminstration-windows/updating-memory-settings.html)" discussion. -### Using the Tomcat Service Monitor ### +(Beware that if you make a change in in this Lucee-Tomcat Service Control panel, that change only takes effect on a restart of the Lucee service. If you restart Lucee using the Lucee Server Admin's _Restart_ option, that restarts the Lucee engine but does not technically restart the Windows Service for Lucee.) -The Tomcat Service Monitor is an applet that runs in the Notification Are of your Windows Start Bar. You can turn it on clicking the "Lucee-Tomcat Service Monitor". Once started, you'll see the Tomcat Monitor in the Notification Area like so: +### Using the Tomcat Service Monitor system tray feature### -You can right-click the service monitor and control the Lucee/Tomcat service from There \ No newline at end of file +The _Tomcat Service Monitor_ is another control panel, which can be opened from the _Start_ Menu for Lucee as `Lucee-Tomcat Service Monitor`. Once enabled, it appears in the Windows System Tray (bottom right corner of your display, by default). You can right-click it to stop/start Lucee, while the "configuration" option launches that _Lucee-Tomcat Service Control_ discussed above. From 227a9537cec59357136721a9d77485c644adac9d Mon Sep 17 00:00:00 2001 From: Charlie Arehart Date: Thu, 23 Feb 2023 17:19:05 -0600 Subject: [PATCH 2/6] Further refinements --- .../01.starting-stoping-lucee/page.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md index c7a80a736..312558f57 100644 --- a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md +++ b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md @@ -3,24 +3,24 @@ title: Start and Stopping Lucee id: windows-start-stop-lucee --- -If you run the Lucee installer, it will create a Windows Service and also enable optional control panels based on the Apache Tomcat on which the installer implemented Lucee. There are then a couple different methods to start or stop the Lucee/Tomcat service on a Windows machine. We'll go over these items here. +If you run the Lucee installer, it will create a Windows Service and also enable optional control panels based on Apache Tomcat which is implemented by the Lucee installer. There are then a couple different methods to start or stop the Lucee/Tomcat service on a Windows machine. We'll go over these items here. -While the Tomcat implementation underlying Lucee also offers other ways to start and stop Lucee from the command line (via the lucee\tomcat\bin folder), this documentation is not referring to that. Note also that using that to startup.bat there will NOT use the configuration discussed below regarding the _Lucee-Tomcat Service Control panel_. +While the Tomcat implementation underlying Lucee also offers other ways to start and stop Lucee from the command line (via the lucee\tomcat\bin folder), this documentation is not referring to that. Note in particular that using that to startup.bat there will NOT use the configuration discussed below regarding the _Lucee-Tomcat Service Control panel_. ### Using Windows Service Controls ### -The Lucee/Tomcat service can be found in the Services control panel, where it can be stopped, started, and otherwise controlled from there. The name of the service may show as "Apache Tomcat 9.0 Lucee", depending on the version of the Lucee installer. +The Lucee/Tomcat service can be found in the Services control panel, where like any Windows service it can be stopped, started, and otherwise controlled from there. The name of the service may show as "Apache Tomcat 9.0 Lucee", depending on the version of the Lucee installer. -Note that if you use Windows Task Manager to view services (in its Services tab), Lucee shows by the name "Lucee". (Technically, this Task Manager display shows a service's "Service name" while the Services panel above shows a service's "Display Name", and those can differ.) +Note that if you use _Windows Task Manager_ to view services (in its _Services_ tab), Lucee appears with the name "Lucee". (Technically, this Task Manager display shows a service's _Service name_ while the Services panel above shows a service's _Display Name_, and those can differ based on how the service was created.) ### Using the Lucee-Tomcat Service Control panel ### -The installer also implements the _Tomcat Service Control_ panel, which can be opened using the Windows _Start_ Menu, where it's found under `Lucee` as the `Lucee-Tomcat Service Control`. +The Lucee installer also implements the _Tomcat Service Control_ panel, which can be opened using the Windows _Start_ Menu, where it's found under `Lucee` as the `Lucee-Tomcat Service Control`. -Once launched the _Tomcat Service Control_ panel also offers the ability to start and stop the Lucee service, but it can also used to customize the Lucee (Tomcat) service settings (such as JVM params). See the "[Updating Memory Settings](lucee-server-adminstration-windows/updating-memory-settings.html)" discussion. +Once launched, the _Tomcat Service Control_ panel also offers the ability to start and stop the Lucee service, but it can also used to customize the Lucee (Tomcat) service settings (such as JVM params). See the "[Updating Memory Settings](lucee-server-adminstration-windows/updating-memory-settings.html)" discussion elsewhere in this Windows Administration section of the docs. -(Beware that if you make a change in in this Lucee-Tomcat Service Control panel, that change only takes effect on a restart of the Lucee service. If you restart Lucee using the Lucee Server Admin's _Restart_ option, that restarts the Lucee engine but does not technically restart the Windows Service for Lucee.) +(Beware that if you make a change in this _Lucee-Tomcat Service Control_ panel, that change only takes effect on a restart of the Lucee _service_. If instead you restart Lucee using the Lucee Server Admin's _Restart_ option, that will restart the Lucee engine but does not technically restart the Windows Service for Lucee, so would NOT see changes you made in the control panel. Always restart the Lucee service using one of the two options discussed above, if you change any configuration settings in that _Lucee-Tomcat Service Control_ panel.) ### Using the Tomcat Service Monitor system tray feature### -The _Tomcat Service Monitor_ is another control panel, which can be opened from the _Start_ Menu for Lucee as `Lucee-Tomcat Service Monitor`. Once enabled, it appears in the Windows System Tray (bottom right corner of your display, by default). You can right-click it to stop/start Lucee, while the "configuration" option launches that _Lucee-Tomcat Service Control_ discussed above. +The _Tomcat Service Monitor_ is another feature which can be opened from the _Start_ Menu for Lucee as `Lucee-Tomcat Service Monitor`. Once enabled, it appears in the Windows System Tray (bottom right corner of your display, by default). You can right-click it to stop/start Lucee, and the "configuration" option launches that _Lucee-Tomcat Service Control_ discussed above. \ No newline at end of file From 3936c81149659dabdfdf6b756cfce7c33674b4a4 Mon Sep 17 00:00:00 2001 From: Charlie Arehart Date: Thu, 23 Feb 2023 17:30:29 -0600 Subject: [PATCH 3/6] Revise and clarify some points --- .../03.updating-memory-settings/page.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/03.updating-memory-settings/page.md b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/03.updating-memory-settings/page.md index 5f656b75b..682d0d1d9 100644 --- a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/03.updating-memory-settings/page.md +++ b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/03.updating-memory-settings/page.md @@ -3,12 +3,14 @@ title: Updating Memory Settings id: windows-update-memory-settings --- -As your site grows and your memory needs increase, you will inevitably need to adjust the memory settings for the Lucee Server JVM from it's default setting of 256MB of RAM. For most sites, this is quite small, but it's small by default so that it can be installed successfully on the majority of devices. +As your site grows and your memory needs increase, you will inevitably need to adjust the memory settings for the Lucee Server JVM from it's default setting of 256MB of RAM. For most sites, this is a quite small amount, but it's small by default so that Lucee can be installed successfully on the majority of devices. -The memory settings of Lucee's JVM is controlled by the Tomcat Service Control. To access the Lucee/Tomcat service control, find the "Lucee-Tomcat Service Control" icon in your start menu. On some OS's, like Windows 7, you have to run the service control as the Administrator. To do this simply RIGHT-CLICK the start-menu item, and select "Run As Administrator" from the menu that appears. +When Lucee is implemented using the Windows installer for Lucee, the memory settings of Lucee's JVM are controlled by the _Lucee-Tomcat Service Control_ panel. To access this, find the "Lucee-Tomcat Service Control" icon in your start menu. -Next, click on the "Java" tab, and edit the min/max JVM heap fields as you see fit. Don't forget to restart Lucee after you make your changes. +(On some versions of Windows, you must run the service control as the Administrator. To do this simply RIGHT-CLICK the start-menu item, and select "Run As Administrator" from the menu that appears.) + +Next, click on the "Java" tab, and edit the min/max JVM heap fields as you see fit. Don't forget to restart Lucee after you make your changes. Please note that you must restart the Lucee service in Windows: if you use the _Restart_ option of the Lucee Server Admin, that will restart the Lucee engine but that would NOT pickup any changes you just made to this _Tomcat-Lucee Service Control_ panel. Restarting the service (or rebooting the box) would pickup such changes. ### Additional JVM Settings ### -The same "Java" tab can be used to pass other parameters to your JVM, such as "-XX:MaxPermSize=128m". Simply add the option to the "Java Options" text area on that same screen. \ No newline at end of file +The same "Java" tab can be used to pass other parameters to your JVM, such as "-XX:MaxPermSize=128m". Simply add the option to the "Java Options" text area on that same screen. note that new items should each be added on a new line within that "Java Options" text area, which differs from when providing mutiple java arguments via other means. \ No newline at end of file From 482c1147761a5e0d10637cf685e862fc05a945a0 Mon Sep 17 00:00:00 2001 From: Charlie Arehart Date: Fri, 24 Feb 2023 22:33:22 -0600 Subject: [PATCH 4/6] Correct markdown mistake --- .../03.updating-memory-settings/page.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/03.updating-memory-settings/page.md b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/03.updating-memory-settings/page.md index 682d0d1d9..f5450f90c 100644 --- a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/03.updating-memory-settings/page.md +++ b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/03.updating-memory-settings/page.md @@ -11,6 +11,6 @@ When Lucee is implemented using the Windows installer for Lucee, the memory sett Next, click on the "Java" tab, and edit the min/max JVM heap fields as you see fit. Don't forget to restart Lucee after you make your changes. Please note that you must restart the Lucee service in Windows: if you use the _Restart_ option of the Lucee Server Admin, that will restart the Lucee engine but that would NOT pickup any changes you just made to this _Tomcat-Lucee Service Control_ panel. Restarting the service (or rebooting the box) would pickup such changes. -### Additional JVM Settings ### +## Additional JVM Settings -The same "Java" tab can be used to pass other parameters to your JVM, such as "-XX:MaxPermSize=128m". Simply add the option to the "Java Options" text area on that same screen. note that new items should each be added on a new line within that "Java Options" text area, which differs from when providing mutiple java arguments via other means. \ No newline at end of file +The same "Java" tab can be used to pass other parameters to your JVM, such as "-XX:MaxPermSize=128m". Simply add the option to the "Java Options" text area on that same screen. note that new items should each be added on a new line within that "Java Options" text area, which differs from when providing mutiple java arguments via other means. From b58ed464fd591d427be58b4d7aac27627b9cb731 Mon Sep 17 00:00:00 2001 From: Charlie Arehart Date: Fri, 24 Feb 2023 22:37:55 -0600 Subject: [PATCH 5/6] Correct bad link --- .../01.starting-stoping-lucee/page.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md index 312558f57..58e88fb07 100644 --- a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md +++ b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md @@ -17,10 +17,10 @@ Note that if you use _Windows Task Manager_ to view services (in its _Services_ The Lucee installer also implements the _Tomcat Service Control_ panel, which can be opened using the Windows _Start_ Menu, where it's found under `Lucee` as the `Lucee-Tomcat Service Control`. -Once launched, the _Tomcat Service Control_ panel also offers the ability to start and stop the Lucee service, but it can also used to customize the Lucee (Tomcat) service settings (such as JVM params). See the "[Updating Memory Settings](lucee-server-adminstration-windows/updating-memory-settings.html)" discussion elsewhere in this Windows Administration section of the docs. +Once launched, the _Tomcat Service Control_ panel also offers the ability to start and stop the Lucee service, but it can also used to customize the Lucee (Tomcat) service settings (such as JVM params). See the "[Updating Memory Settings](../03.updating-memory-settings/page.md)" discussion elsewhere in this Windows Administration section of the docs. (Beware that if you make a change in this _Lucee-Tomcat Service Control_ panel, that change only takes effect on a restart of the Lucee _service_. If instead you restart Lucee using the Lucee Server Admin's _Restart_ option, that will restart the Lucee engine but does not technically restart the Windows Service for Lucee, so would NOT see changes you made in the control panel. Always restart the Lucee service using one of the two options discussed above, if you change any configuration settings in that _Lucee-Tomcat Service Control_ panel.) ### Using the Tomcat Service Monitor system tray feature### -The _Tomcat Service Monitor_ is another feature which can be opened from the _Start_ Menu for Lucee as `Lucee-Tomcat Service Monitor`. Once enabled, it appears in the Windows System Tray (bottom right corner of your display, by default). You can right-click it to stop/start Lucee, and the "configuration" option launches that _Lucee-Tomcat Service Control_ discussed above. \ No newline at end of file +The _Tomcat Service Monitor_ is another feature which can be opened from the _Start_ Menu for Lucee as `Lucee-Tomcat Service Monitor`. Once enabled, it appears in the Windows System Tray (bottom right corner of your display, by default). You can right-click it to stop/start Lucee, and the "configuration" option launches that _Lucee-Tomcat Service Control_ discussed above. From d5ac176c763371d7e2ba62ea6a3e5409feff8c49 Mon Sep 17 00:00:00 2001 From: Charlie Arehart Date: Fri, 24 Feb 2023 22:39:25 -0600 Subject: [PATCH 6/6] Correct markdown mistake --- .../01.starting-stoping-lucee/page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md index 58e88fb07..7d6fbdc38 100644 --- a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md +++ b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/01.starting-stoping-lucee/page.md @@ -21,6 +21,6 @@ Once launched, the _Tomcat Service Control_ panel also offers the ability to sta (Beware that if you make a change in this _Lucee-Tomcat Service Control_ panel, that change only takes effect on a restart of the Lucee _service_. If instead you restart Lucee using the Lucee Server Admin's _Restart_ option, that will restart the Lucee engine but does not technically restart the Windows Service for Lucee, so would NOT see changes you made in the control panel. Always restart the Lucee service using one of the two options discussed above, if you change any configuration settings in that _Lucee-Tomcat Service Control_ panel.) -### Using the Tomcat Service Monitor system tray feature### +### Using the Tomcat Service Monitor system tray feature The _Tomcat Service Monitor_ is another feature which can be opened from the _Start_ Menu for Lucee as `Lucee-Tomcat Service Monitor`. Once enabled, it appears in the Windows System Tray (bottom right corner of your display, by default). You can right-click it to stop/start Lucee, and the "configuration" option launches that _Lucee-Tomcat Service Control_ discussed above.