From 1fbe5c8b48360d2e29c16df49f9dc964924ac3e4 Mon Sep 17 00:00:00 2001
From: labkey-jeckels <jeckels@labkey.com>
Date: Tue, 30 Jan 2024 15:34:48 -0800
Subject: [PATCH 1/2] IntelliJ debug config updates for embedded Tomcat

---
 .../LabKey_Embedded_Tomcat_Dev.xml                  | 13 +++++++++++++
 .../templates/LabKeyEmbedded_Dev.xml                |  2 +-
 2 files changed, 14 insertions(+), 1 deletion(-)
 create mode 100644 .idea/runConfigurations/LabKey_Embedded_Tomcat_Dev.xml

diff --git a/.idea/runConfigurations/LabKey_Embedded_Tomcat_Dev.xml b/.idea/runConfigurations/LabKey_Embedded_Tomcat_Dev.xml
new file mode 100644
index 0000000000..40ca0f8308
--- /dev/null
+++ b/.idea/runConfigurations/LabKey_Embedded_Tomcat_Dev.xml
@@ -0,0 +1,13 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="LabKey Embedded Tomcat Dev" type="Application" factoryName="Application">
+    <option name="ALTERNATIVE_JRE_PATH" value="labkey" />
+    <option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
+    <option name="MAIN_CLASS_NAME" value="org.labkey.embedded.LabKeyServer" />
+    <module name="labkey-server.server.embedded.main" />
+    <option name="VM_PARAMETERS" value="--add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.desktop/java.awt.font=ALL-UNNAMED --add-opens=java.base/java.text=ALL-UNNAMED -Ddevmode=true -ea -Dsun.io.useCanonCaches=false -Xmx2G" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/build/deploy/embedded" />
+    <method v="2">
+      <option name="Make" enabled="true" />
+    </method>
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.idea/runConfigurations/templates/LabKeyEmbedded_Dev.xml b/.idea/runConfigurations/templates/LabKeyEmbedded_Dev.xml
index 4061563580..1ad0a73654 100644
--- a/.idea/runConfigurations/templates/LabKeyEmbedded_Dev.xml
+++ b/.idea/runConfigurations/templates/LabKeyEmbedded_Dev.xml
@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="LabKeyEmbbedded_Dev" type="SpringBootApplicationConfigurationType" factoryName="Spring Boot">
+  <configuration default="false" name="Spring Boot LabKey Embedded Tomcat Dev" type="SpringBootApplicationConfigurationType" factoryName="Spring Boot">
     <module name="labkey-server.server.embedded.main" />
     <option name="SPRING_BOOT_MAIN_CLASS" value="org.labkey.embedded.LabKeyServer" />
     <option name="HIDE_BANNER" value="true" />

From 3a2d14180523d54b7b57122c18faedb96fa35c02 Mon Sep 17 00:00:00 2001
From: labkey-jeckels <jeckels@labkey.com>
Date: Tue, 30 Jan 2024 16:36:27 -0800
Subject: [PATCH 2/2] Update guidance for developers

---
 server/embedded/README.md | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/server/embedded/README.md b/server/embedded/README.md
index f1874f9dbf..65f92ee21c 100644
--- a/server/embedded/README.md
+++ b/server/embedded/README.md
@@ -1,5 +1,6 @@
 # embedded
-LabKey Server can now be started with embedded Tomcat. **This feature is in development phase and not ready for use in production. Free versions of IntelliJ may lack support for Spring boot debug configurations required to run the embedded Tomcat.**
+LabKey Server now uses embedded Tomcat, which bundles a fully tested copy of Tomcat and simplifies configuration.
+This is the supported way to run LabKey Server as of version 24.3, replacing deploying into a standalone Tomcat installation.
 
 ### Setup
 1. Within the root-level `gradle.properties` file, uncomment the `useEmbeddedTomcat` and `useLocalBuild` properties.  If using SSL, also uncomment the `useSsl` property (and see further instructions below).
@@ -7,7 +8,10 @@ LabKey Server can now be started with embedded Tomcat. **This feature is in deve
 3. `gradlew pickPg` or `gradlew pickMSSQL`
 4. `gradlew deployApp`
 5. Within IntelliJ, do a Gradle Refresh in the Gradle Window
-6. To start Tomcat within IntelliJ, select LabKeyEmbedded_Dev from the Run Configurations. (It will appear in a different section of the menu from the other LabKey configurations.)
+6. To start Tomcat within IntelliJ, select `Spring Boot LabKey Embedded Tomcat Dev` from the Run Configurations. (It
+   will appear in a different section of the menu from the other LabKey configurations.) If you are using the free
+   Community Edition of IntelliJ which doesn't natively support Spring Boot, use the `LabKey Embedded Tomcat Dev`
+   configuration instead.
 
 #### Embedded tomcat gradle properties explained:
 + `useEmbeddedTomcat` - if present, this will cause the :server:embedded project to be included in your local set of Gradle projects to be built.  This also will affect the behavior of the `pickPg`, `pickMSSQL`, and `deployApp` tasks and is required to be present in order to build a distribution with an embedded Tomcat server. This property is present in the root-level `gradle.properties` file, but commented out by default.
@@ -35,8 +39,8 @@ The following task has been added as well
 
 #### Troubleshooting
 + If starting your server from the LabKeyEmbedded_Dev configuration fails, this is likely due to IntelliJ not being able to find the embedded project on which the configuration depends. There are a few things you should check:
-    + Ensure that the `useEmbeddedTomcat` property is uncommented in the root-level `build.gradle` file
-    + Within the Gradle window, ensure that the `:server:embedded` project is listed.  If it is not, run the task `gradle projects` on the command line to see if it appears in that listing.  If it does, try a Gradle refresh within IntelliJ.  If it is not in the output from the `projects` command, look at your `settings.gradle` file to see why this might be.
-    + From the Configurations menu, choose the "Edit Configurations ..." and then under the Spring Boot section, choose the `LabKeyEmbedded_Dev` configuration.
-    + If the there is nothing selected for "Use classpath of module", open the dropdown and choose `<root>.server.embedded.main`, where `<root>` is the name of the root of your enlistment.
-    + If there are no options presented for "Use classpath of module" and the embedded module does appear in the Gradle projects listing, try `File -> Invalidate Caches / Restart`
+  + Ensure that the `useEmbeddedTomcat` property is uncommented in the root-level `build.gradle` file
+  + Within the Gradle window, ensure that the `:server:embedded` project is listed.  If it is not, run the task `gradle projects` on the command line to see if it appears in that listing.  If it does, try a Gradle refresh within IntelliJ.  If it is not in the output from the `projects` command, look at your `settings.gradle` file to see why this might be.
+  + From the Configurations menu, choose the "Edit Configurations ..." and then under the Spring Boot section, choose the `LabKeyEmbedded_Dev` configuration.
+  + If the there is nothing selected for "Use classpath of module", open the dropdown and choose `<root>.server.embedded.main`, where `<root>` is the name of the root of your enlistment.
+  + If there are no options presented for "Use classpath of module" and the embedded module does appear in the Gradle projects listing, try `File -> Invalidate Caches / Restart`