Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Windows Start Docs #1352

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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 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 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 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 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 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 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 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 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](../03.updating-memory-settings/page.md)" discussion elsewhere in this Windows Administration section of the docs.

### Using the Tomcat Service Monitor ###
(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.)

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
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.
Original file line number Diff line number Diff line change
Expand Up @@ -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.)

### Additional JVM Settings ###
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.

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.
## 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.