From 77b37b7cf8349f4fcdcc1093d9a5548512c4871c Mon Sep 17 00:00:00 2001
From: yu-i-i <kla9555@gmail.com>
Date: Thu, 22 May 2025 04:00:22 +0200
Subject: [PATCH] Update README.md: Changes to Template Gallery and Sandboxed
 Compiles, v5.4.1-ext-v3

---
 README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 53 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 9018b4d75b..a7729e2340 100644
--- a/README.md
+++ b/README.md
@@ -58,12 +58,12 @@ Here, the attached volume provides convenient access for the container to the ce
 
 If you want to build a Docker image of the extended CE based on the upstream v5.4.0 codebase, you can check out the corresponding tag by running:
 ```
-git checkout v5.4.0-ext-v2
+git checkout v5.4.1-ext-v3
 ```
-After building the image, switch to the latest state of the repository and check the `server-ce/hotfix` directory. If a subdirectory matching your version (e.g., `5.4.0`) exists, build a patched image.
+After building the image, switch to the latest state of the repository and check the `server-ce/hotfix` directory. If a subdirectory matching your version (e.g., `5.4.1`) exists, build a patched image.
 Alternatively, you can download a prebuilt image from Docker Hub:
 ```
-docker pull overleafcep/sharelatex:5.4.0-ext-v2
+docker pull overleafcep/sharelatex:5.4.1-ext-v3
 ```
 Make sure to update the image name in overleaf-toolkit/config/docker-compose.override.yml accordingly.
 
@@ -74,6 +74,50 @@ Make sure to update the image name in overleaf-toolkit/config/docker-compose.ove
 - Improved keyboard input experience in the Symbol Palette
 - Fixed compilation error when using the `minted` package
 
+### New in `v5.4.1-ext-v3`:
+
+- Based on upstream codebase v5.4.1
+- Sandboxed compiles: Made the `TEX_LIVE_DOCKER_IMAGE` environment variable optional
+- Template Gallery: Fixed bugs
+- Template Gallery: improved visual presentation of modals and enhanced keyboard interactions
+- Template Gallery **breaking change**: Replaced the free-text license field with a dropdown (select box).
+<details>
+<summary><h4><em>Details</em></h4></summary>
+
+In [this commit](https://github.com/overleaf/overleaf/commit/6ac0a46dfe537904e30951c137629ae9aca3c445) the free-text license field in the Template Gallery code has been replaced with a dropdown (select box).
+To update your template database, run the following command:
+```
+overleaf-toolkit/bin/docker-compose" exec -T mongo mongosh sharelatex < updateLicenses.js
+```
+The `updateLicenses.js` script is as follows:
+```
+db.templates.updateMany({ license: { $nin: ["cc_by_4.0", "lppl_1.3c", "other"] } },
+  [
+    {
+      $set: {
+        license: {
+          $switch: {
+            branches: [
+              {
+                case: { $eq: ["$license", "Creative Commons CC BY 4.0"] },
+                then: "cc_by_4.0"
+              },
+              {
+                case: { $eq: ["$license", "LaTeX Project Public License 1.3c"] },
+                then: "lppl_1.3c"
+              }
+            ],
+            default: "other"
+          }
+        }
+      }
+    }
+  ]
+)
+```
+</details>
+
+
 ## Sandboxed Compiles
 
 To enable sandboxed compiles (also known as "Sibling containers"), set the following configuration options in `overleaf-toolkit/config/overleaf.rc`:
@@ -87,11 +131,12 @@ The following environment variables are used to specify which TeX Live images to
 
 - `ALL_TEX_LIVE_DOCKER_IMAGES` **(required)**
     * A comma-separated list of TeX Live images to use. These images will be downloaded or updated.
-      To skip downloading the images, set `SIBLING_CONTAINERS_PULL=false` in `config/overleaf.rc`.
+      To skip downloading, set `SIBLING_CONTAINERS_PULL=false` in `config/overleaf.rc`.
 - `ALL_TEX_LIVE_DOCKER_IMAGE_NAMES`
     * A comma-separated list of friendly names for the images. If omitted, the version name will be used (e.g., `latest-full`).
-- `TEX_LIVE_DOCKER_IMAGE` **(required)**
-    * The default TeX Live image that will be used for compiling new projects. The environment variable `ALL_TEX_LIVE_DOCKER_IMAGES` must include this image.
+- `TEX_LIVE_DOCKER_IMAGE`
+    * The default TeX Live image used for compiling new projects. This image must be included in `ALL_TEX_LIVE_DOCKER_IMAGES`. If not set,
+       the first image in `ALL_TEX_LIVE_DOCKER_IMAGES` will be used as the default image.
 
 Users can select the image for their project in the project menu.
 
@@ -160,7 +205,7 @@ NAV_HIDE_POWERED_BY=true
 ## Sandboxed Compiles ##
 ########################
 
-ALL_TEX_LIVE_DOCKER_IMAGES=texlive/texlive:latest-full, texlive/texlive:TL2023-historic
+ALL_TEX_LIVE_DOCKER_IMAGES=texlive/texlive:latest-full, texlive/texlive:TL2024-historic
 ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=TeXLive 2024, TeXLive 2023
 TEX_LIVE_DOCKER_IMAGE=texlive/texlive:latest-full
 TEX_COMPILER_EXTRA_FLAGS=-shell-escape
@@ -179,6 +224,7 @@ file to your project using its URL, while the *Insert Figure* dropdown lets you
 
 ## Template Gallery
 
+
 The Template Gallery feature is controlled using the following environment variables:
 
 - `OVERLEAF_TEMPLATE_GALLERY`: Set to `true` to enable the Template Gallery.