diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE.md
similarity index 83%
rename from .github/ISSUE_TEMPLATE/bug_report.md
rename to .github/ISSUE_TEMPLATE.md
index 9c0577106e..3a375bcbe9 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,19 +1,10 @@
----
-name: Bug report
-about: Report a bug
-title: ''
-labels: type:bug
-assignees: ''
-
----
-
diff --git a/README.md b/README.md
index 33e7a8956b..a7729e2340 100644
--- a/README.md
+++ b/README.md
@@ -37,12 +37,6 @@ The present "extended" version of Overleaf CE includes:
- Symbol Palette
- "From External URL" feature
-> [!CAUTION]
-> Overleaf Community Edition is intended for use in environments where **all** users are trusted. Community Edition is **not** appropriate for scenarios where isolation of users is required due to Sandbox Compiles not being available. When not using Sandboxed Compiles, users have full read and write access to the `sharelatex` container resources (filesystem, network, environment variables) when running LaTeX compiles.
-Therefore, in any environment where not all users can be fully trusted, it is strongly recommended to enable the Sandboxed Compiles feature available in the Extended Community Edition.
-
-For more information on Sandbox Compiles check out Overleaf [documentation](https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/sandboxed-compiles).
-
## Enterprise
If you want help installing and maintaining Overleaf in your lab or workplace, Overleaf offers an officially supported version called [Overleaf Server Pro](https://www.overleaf.com/for/enterprises).
@@ -50,16 +44,1005 @@ If you want help installing and maintaining Overleaf in your lab or workplace, O
## Installation
Detailed installation instructions can be found in the [Overleaf Toolkit](https://github.com/overleaf/toolkit/).
-Configuration details and release history for the Extended Community Edition can be found on the [Extended CE Wiki Page](https://github.com/yu-i-i/overleaf-cep/wiki).
+To run a custom image, add a file named docker-compose.override.yml with the following or similar content into the `overleaf-toolkit/config directory`:
+
+```yml
+---
+services:
+ sharelatex:
+ image: sharelatex/sharelatex:ext-ce
+ volumes:
+ - ../config/certs:/overleaf/certs
+```
+Here, the attached volume provides convenient access for the container to the certificates needed for SAML or LDAP authentication.
+
+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.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.1`) exists, build a patched image.
+Alternatively, you can download a prebuilt image from Docker Hub:
+```
+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.
+
+### New in `v5.4.0-ext-v2`:
+
+- Added "From External URL" feature
+- Introduced Template Gallery
+- 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
+
+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"
+ }
+ }
+ }
+ }
+ ]
+)
+```
+
+
+
+## Sandboxed Compiles
+
+To enable sandboxed compiles (also known as "Sibling containers"), set the following configuration options in `overleaf-toolkit/config/overleaf.rc`:
+
+```
+SERVER_PRO=true
+SIBLING_CONTAINERS_ENABLED=true
+```
+
+The following environment variables are used to specify which TeX Live images to use for sandboxed compiles:
+
+- `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, 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`
+ * 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.
+
+Here is an example where the default TeX Live image is `latest-full` from Docker Hub, but the `TL2024-historic` image can be used for older projects:
+```
+ALL_TEX_LIVE_DOCKER_IMAGES=texlive/texlive:latest-full, texlive/texlive:TL2024-historic
+ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=TeXLive 2025, TeXLive 2024
+TEX_LIVE_DOCKER_IMAGE=texlive/texlive:latest-full
+```
+For additional details refer to
+[Server Pro: Sandboxed Compiles](https://github.com/overleaf/overleaf/wiki/Server-Pro:-Sandboxed-Compiles) and
+[Toolkit: Sandboxed Compiles](https://github.com/overleaf/toolkit/blob/master/doc/sandboxed-compiles.md).
+
+When the compilation takes place in a dedicated container, it is relatively safe to permit running external commands from inside the TeX
+file during compilation. This is required for packages like `minted`. For this purpose, the following environment variable can be used:
+
+- `TEX_COMPILER_EXTRA_FLAGS`
+ * A list of extra flags for TeX compiler. Example: `-shell-escape -file-line-error`
+
+
+
Sample variables.env file
+
+```
+OVERLEAF_APP_NAME="Our Overleaf Instance"
+
+ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url
+
+# Enables Thumbnail generation using ImageMagick
+ENABLE_CONVERSIONS=true
+
+# Disables email confirmation requirement
+EMAIL_CONFIRMATION_DISABLED=true
+
+## Nginx
+# NGINX_WORKER_PROCESSES=4
+# NGINX_WORKER_CONNECTIONS=768
+
+## Set for TLS via nginx-proxy
+# OVERLEAF_BEHIND_PROXY=true
+# OVERLEAF_SECURE_COOKIE=true
+
+OVERLEAF_SITE_URL=http://my-overleaf-instance.com
+OVERLEAF_NAV_TITLE=Our Overleaf Instance
+# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png
+OVERLEAF_ADMIN_EMAIL=support@example.com
+
+OVERLEAF_LEFT_FOOTER=[{"text": "Contact your support team", "url": "mailto:support@example.com"}]
+OVERLEAF_RIGHT_FOOTER=[{"text":"Hello, I am on the Right", "url":"https://github.com/yu-i-i/overleaf-cep"}]
+
+OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com
+OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com
+OVERLEAF_EMAIL_SMTP_PORT=587
+OVERLEAF_EMAIL_SMTP_SECURE=false
+# OVERLEAF_EMAIL_SMTP_USER=
+# OVERLEAF_EMAIL_SMTP_PASS=
+# OVERLEAF_EMAIL_SMTP_NAME=
+OVERLEAF_EMAIL_SMTP_LOGGER=false
+OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true
+OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false
+OVERLEAF_CUSTOM_EMAIL_FOOTER=This system is run by department x
+
+OVERLEAF_PROXY_LEARN=true
+NAV_HIDE_POWERED_BY=true
+
+########################
+## Sandboxed Compiles ##
+########################
+
+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
+```
+
+
+## "From External URL" feature
+
+To enable the ["From External URL"](https://www.overleaf.com/learn/how-to/How_to_upload_a_file_using_an_external_URL) feature the variable
+`ENABLED_LINKED_FILE_TYPES` must include `url` type:
+```
+ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url
+```
+This will extend both the *Add Files* menu and the *Insert Figure* dropdown in the toolbar: the *Add Files* menu allows you to add a
+file to your project using its URL, while the *Insert Figure* dropdown lets you insert an image into your document directly from its URL.
+
+## Template Gallery
+
+
+The Template Gallery feature is controlled using the following environment variables:
+
+- `OVERLEAF_TEMPLATE_GALLERY`: Set to `true` to enable the Template Gallery.
+
+- `OVERLEAF_TEMPLATE_CATEGORIES`: An optional whitespace-separated list of zero or more template category keys. Valid keys include:
+ _`academic-journal book presentation poster cv homework bibliography calendar formal-letter report thesis newsletter`_
+
+ The special key `all` is automatically appended. This key represents a category that includes all templates.
+
+ For each category key, the following optional environment variables can be set:
+ - `TEMPLATE__NAME`: The display name of the template category.
+ - `TEMPLATE__DESCRIPTION`: A short description of the category.
+
+ If a category key contains a hyphen (`-`), replace it with an underscore (`_`) in the environment variable names.
+
+- `ENABLE_CONVERSIONS`: Must be set to `true` to enable thumbnail and preview generation for templates.
+
+- `OVERLEAF_NON_ADMIN_CAN_PUBLISH_TEMPLATES`: Determines whether non-admin users can publish templates. Defaults to `false`.
+
+To publish a project as a template, select the appropriate option from the project menu. In the form that appears, enter the template details:
+
+
+- The *Title* must be unique.
+- The *Description* field supports Markdown formatting.
+- The *Author* field accepts Markdown-formatted links.
+
+After submission, template details can be edited, or the template can be deleted via the Template Gallery page.
+Users can manage their own templates; admins can manage any template.
+
+
+
Example
+
+```
+#################
+# TEMPLATES #
+#################
+
+ENABLE_CONVERSIONS=true
+
+OVERLEAF_TEMPLATE_GALLERY=true
+OVERLEAF_NON_ADMIN_CAN_PUBLISH_TEMPLATES=true
+OVERLEAF_TEMPLATE_CATEGORIES=academic-journal book presentation poster cv homework bibliography calendar formal-letter report thesis newsletter
+
+TEMPLATE_ACADEMIC_JOURNAL_NAME=Journal articles
+TEMPLATE_ACADEMIC_JOURNAL_DESCRIPTION=Templates for academic journal submissions, including formats for major publishers and preprint servers.
+
+TEMPLATE_BIBLIOGRAPHY_NAME=Bibliographies
+TEMPLATE_BIBLIOGRAPHY_DESCRIPTION=Styles for creating and managing bibliographies with BibTeX or BibLaTeX. Suitable for use in academic papers, theses, and reports.
+
+TEMPLATE_BOOK_NAME=Books
+TEMPLATE_BOOK_DESCRIPTION=Templates for writing books or long-form documents, including chapter structuring, front matter, and indexing.
+
+TEMPLATE_CALENDAR_NAME=Calendars
+TEMPLATE_CALENDAR_DESCRIPTION=Templates to create yearly, monthly, or weekly calendars. Useful for personal planners or event scheduling.
+
+TEMPLATE_CV_NAME=CVs and résumés
+TEMPLATE_CV_DESCRIPTION=Templates for CVs and résumés with various formats for academic, industry, and creative positions.
+
+TEMPLATE_FORMAL_LETTER_NAME=Formal letters
+TEMPLATE_FORMAL_LETTER_DESCRIPTION=Templates for professional letters, such as cover letters, recommendation letters, and official correspondence.
+
+TEMPLATE_HOMEWORK_NAME=Assignments
+TEMPLATE_HOMEWORK_DESCRIPTION=Templates for homework, coursework, and problem sets. Designed to be clean and well-structured for students and educators.
+
+TEMPLATE_NEWSLETTER_NAME=Newsletters
+TEMPLATE_NEWSLETTER_DESCRIPTION=Templates for creating newsletters with formats for academic, corporate, or community communications.
+
+TEMPLATE_POSTER_NAME=Posters
+TEMPLATE_POSTER_DESCRIPTION=Templates for scientific and academic posters, typically used in conferences and research presentations.
+
+TEMPLATE_PRESENTATION_NAME=Presentations
+TEMPLATE_PRESENTATION_DESCRIPTION=Templates for Beamer and other presentation formats, tailored for academic talks and lectures.
+
+TEMPLATE_REPORT_NAME=Reports
+TEMPLATE_REPORT_DESCRIPTION=Templates for technical, lab, or project reports. Includes sections for figures, tables, and references.
+
+TEMPLATE_THESIS_NAME=Theses
+TEMPLATE_THESIS_DESCRIPTION=Templates for writing theses and dissertations, following institutional formatting and citation guidelines.
+
+TEMPLATE_ALL_NAME=All templates
+TEMPLATE_ALL_DESCRIPTION=Browse a collection of all available LaTeX templates, categorized by document type, style, and purpose.
+
+```
+
+
+
+
+## Authentication Methods
+
+The following authentication methods are supported: local authentication, LDAP authentication, SAML authentication,
+and OpenID Connect (OIDC) authentication. Local authentication is always active. The environment variable `EXTERNAL_AUTH`
+specifies which external authentication methods are activated. The value of this variable is a list. If the list includes `ldap`, `saml`, or `oidc`,
+then LDAP authentication, SAML authentication, and OIDC authentication will be activated, respectively.
+
+For example: `EXTERNAL_AUTH=ldap saml oidc`
+
+This configuration activates all available authentication methods, although this is rarely necessary.
+
+
+
Local Authentication
+
+Password of local users stored in the MongoDB database. An admin user can create a new local user. For details, visit the
+[wiki of Overleaf project](https://github.com/overleaf/overleaf/wiki/Creating-and-managing-users).
+
+It is possible to enforce password restrictions on local users:
+
+
+* `OVERLEAF_PASSWORD_VALIDATION_MIN_LENGTH`: The minimum length required
+
+* `OVERLEAF_PASSWORD_VALIDATION_MAX_LENGTH`: The maximum length allowed
+
+* `OVERLEAF_PASSWORD_VALIDATION_PATTERN`: is used to validate password strength
+
+ - `abc123` – password requires 3 letters and 3 numbers and be at least 6 characters long
+ - `aA` – password requires lower and uppercase letters and be at least 2 characters long
+ - `ab$3` – it must contain letters, digits and symbols and be at least 4 characters long
+ - There are 4 groups of characters: letters, UPPERcase letters, digits, symbols. Anything that is neither a letter nor a digit is considered to be a symbol.
+
+
+
+
+
LDAP Authentication
+
+Internally, Overleaf LDAP uses the [passport-ldapauth](https://github.com/vesse/passport-ldapauth) library. Most of these configuration options are passed through to the `server` config object which is used to configure `passport-ldapauth`. If you are having issues configuring LDAP, it is worth reading the README for `passport-ldapauth` to understand the configuration it expects.
+
+When using Local and LDAP authentication methods, a user enters a `username` and `password` in the login form. If LDAP authentication is enabled, it is attempted first:
+
+1. An LDAP user is searched for in the LDAP directory using the filter defined by `OVERLEAF_LDAP_SEARCH_FILTER` and authenticated.
+2. If authentication is successful, the Overleaf users database is checked for a user with the primary email address that matches the email address of the authenticated LDAP user:
+ - If a matching user is found, the `hashedPassword` field for this user is deleted (if it exists). This ensures that the user can only log in via LDAP authentication in the future.
+ - If no matching user is found, a new Overleaf user is created using the email, first name, and last name retrieved from the LDAP server.
+3. If LDAP authentication fails or is unsuccessful, local authentication is attempted.
+
+#### Environment Variables
+
+- `OVERLEAF_LDAP_URL` **(required)**
+ * URL of the LDAP server.
+
+ - Example: `ldaps://ldap.example.com:636` (LDAP over SSL)
+ - Example: `ldap://ldap.example.com:389` (unencrypted or STARTTLS, if configured).
+
+- `OVERLEAF_LDAP_EMAIL_ATT`
+ * The email attribute returned by the LDAP server, default `mail`. Each LDAP user must have at least one email address.
+ If multiple addresses are provided, only the first one will be used.
+
+- `OVERLEAF_LDAP_FIRST_NAME_ATT`
+ * The property name holding the first name of the user which is used in the application, usually `givenName`.
+
+- `OVERLEAF_LDAP_LAST_NAME_ATT`
+ * The property name holding the family name of the user which is used in the application, usually `sn`.
+
+- `OVERLEAF_LDAP_NAME_ATT`
+ * The property name holding the full name of the user, usually `cn`. If either of the two previous variables is not defined,
+ the first and/or last name of the user is extracted from this variable. Otherwise, it is not used.
+
+- `OVERLEAF_LDAP_PLACEHOLDER`
+ * The placeholder for the login form, defaults to `Username`.
+
+- `OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN`
+ * If set to `true`, updates the LDAP user `first_name` and `last_name` field on login, and turn off the user details form on the `/user/settings`
+ page for LDAP users. Otherwise, details will be fetched only on first login.
+
+- `OVERLEAF_LDAP_BIND_DN`
+ * The distinguished name of the LDAP user that should be used for the LDAP connection
+ (this user should be able to search/list accounts on the LDAP server),
+ e.g., `cn=ldap_reader,dc=example,dc=com`. If not defined, anonymous binding is used.
+
+- `OVERLEAF_LDAP_BIND_CREDENTIALS`
+ * Password for `OVERLEAF_LDAP_BIND_DN`.
+
+- `OVERLEAF_LDAP_BIND_PROPERTY`
+ * Property of the user to bind against the client, defaults to `dn`.
+
+- `OVERLEAF_LDAP_SEARCH_BASE` **(required)**
+ * The base DN from which to search for users. E.g., `ou=people,dc=example,dc=com`.
+
+- `OVERLEAF_LDAP_SEARCH_FILTER`
+ * LDAP search filter with which to find a user. Use the literal '{{username}}' to have the given username be interpolated in for the LDAP search.
+
+ - Example: `(|(uid={{username}})(mail={{username}}))` (user can login with email or with login name).
+ - Example: `(sAMAccountName={{username}})` (Active Directory).
+
+- `OVERLEAF_LDAP_SEARCH_SCOPE`
+ * The scope of the search can be `base`, `one`, or `sub` (default).
+
+- `OVERLEAF_LDAP_SEARCH_ATTRIBUTES`
+ * JSON array of attributes to fetch from the LDAP server, e.g., `["uid", "mail", "givenName", "sn"]`.
+ By default, all attributes are fetched.
+
+- `OVERLEAF_LDAP_STARTTLS`
+ * If `true`, LDAP over TLS is used.
+
+- `OVERLEAF_LDAP_TLS_OPTS_CA_PATH`
+ * Path to the file containing the CA certificate used to verify the LDAP server's SSL/TLS certificate. If there are multiple certificates, then
+ it can be a JSON array of paths to the certificates. The files must be accessible to the docker container.
+
+ - Example (one certificate): `/overleaf/certs/ldap_ca_cert.pem`
+ - Example (multiple certificates): `["/overleaf/certs/ldap_ca_cert1.pem", "/overleaf/certs/ldap_ca_cert2.pem"]`
+
+- `OVERLEAF_LDAP_TLS_OPTS_REJECT_UNAUTH`
+ * If `true`, the server certificate is verified against the list of supplied CAs.
+
+- `OVERLEAF_LDAP_CACHE`
+ * If `true`, then up to 100 credentials at a time will be cached for 5 minutes.
+
+- `OVERLEAF_LDAP_TIMEOUT`
+ * How long the client should let operations live for before timing out, ms (Default: Infinity).
+
+- `OVERLEAF_LDAP_CONNECT_TIMEOUT`
+ * How long the client should wait before timing out on TCP connections, ms (Default: OS default).
+
+- `OVERLEAF_LDAP_IS_ADMIN_ATT` and `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE`
+ * When both environment variables are set, the login process updates `user.isAdmin = true` if the LDAP profile contains the attribute specified by
+ `OVERLEAF_LDAP_IS_ADMIN_ATT` and its value either matches `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE` or is an array containing `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE`,
+ otherwise `user.isAdmin` is set to `false`. If either of these variables is not set, then the admin status is only set to `true` during admin user
+ creation in Launchpad.
+
+The following five variables are used to configure how user contacts are retrieved from the LDAP server.
+
+- `OVERLEAF_LDAP_CONTACTS_FILTER`
+ * The filter used to search for users in the LDAP server to be loaded into contacts. The placeholder '{{userProperty}}' within the filter is replaced with the value of
+ the property specified by `OVERLEAF_LDAP_CONTACTS_PROPERTY` from the LDAP user initiating the search. If not defined, no users are retrieved from the LDAP server into contacts.
+
+- `OVERLEAF_LDAP_CONTACTS_SEARCH_BASE`
+ * Specifies the base DN from which to start searching for the contacts. Defaults to `OVERLEAF_LDAP_SEARCH_BASE`.
+
+- `OVERLEAF_LDAP_CONTACTS_SEARCH_SCOPE`
+ * The scope of the search can be `base`, `one`, or `sub` (default).
+
+- `OVERLEAF_LDAP_CONTACTS_PROPERTY`
+ * Specifies the property of the user object that will replace the '{{userProperty}}' placeholder in the `OVERLEAF_LDAP_CONTACTS_FILTER`.
+
+- `OVERLEAF_LDAP_CONTACTS_NON_LDAP_VALUE`
+ * Specifies the value of the `OVERLEAF_LDAP_CONTACTS_PROPERTY` if the search is initiated by a non-LDAP user. If this variable is not defined, the resulting filter
+ will match nothing. The value `*` can be used as a wildcard.
+
+
+
Example
+
+ OVERLEAF_LDAP_CONTACTS_FILTER=(gidNumber={{userProperty}})
+ OVERLEAF_LDAP_CONTACTS_PROPERTY=gidNumber
+ OVERLEAF_LDAP_CONTACTS_NON_LDAP_VALUE=1000
+
+The above example results in loading into the contacts of the current LDAP user all LDAP users who have the same UNIX `gid`. Non-LDAP users will have all LDAP users with UNIX `gid=1000` in their contacts.
+
+
+
+
+
+
Sample variables.env file
+
+```
+OVERLEAF_APP_NAME="Our Overleaf Instance"
+
+ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url
+
+# Enables Thumbnail generation using ImageMagick
+ENABLE_CONVERSIONS=true
+
+# Disables email confirmation requirement
+EMAIL_CONFIRMATION_DISABLED=true
+
+## Nginx
+# NGINX_WORKER_PROCESSES=4
+# NGINX_WORKER_CONNECTIONS=768
+
+## Set for TLS via nginx-proxy
+# OVERLEAF_BEHIND_PROXY=true
+# OVERLEAF_SECURE_COOKIE=true
+
+OVERLEAF_SITE_URL=http://my-overleaf-instance.com
+OVERLEAF_NAV_TITLE=Our Overleaf Instance
+# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png
+OVERLEAF_ADMIN_EMAIL=support@example.com
+
+OVERLEAF_LEFT_FOOTER=[{"text": "Contact your support team", "url": "mailto:support@example.com"}]
+OVERLEAF_RIGHT_FOOTER=[{"text":"Hello, I am on the Right", "url":"https://github.com/yu-i-i/overleaf-cep"}]
+
+OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com
+OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com
+OVERLEAF_EMAIL_SMTP_PORT=587
+OVERLEAF_EMAIL_SMTP_SECURE=false
+# OVERLEAF_EMAIL_SMTP_USER=
+# OVERLEAF_EMAIL_SMTP_PASS=
+# OVERLEAF_EMAIL_SMTP_NAME=
+OVERLEAF_EMAIL_SMTP_LOGGER=false
+OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true
+OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false
+OVERLEAF_CUSTOM_EMAIL_FOOTER=This system is run by department x
+
+OVERLEAF_PROXY_LEARN=true
+NAV_HIDE_POWERED_BY=true
+
+#################
+## LDAP for CE ##
+#################
+
+EXTERNAL_AUTH=ldap
+OVERLEAF_LDAP_URL=ldap://ldap.example.com:389
+OVERLEAF_LDAP_STARTTLS=true
+OVERLEAF_LDAP_TLS_OPTS_CA_PATH=/overleaf/certs/ldap_ca_cert.pem
+OVERLEAF_LDAP_SEARCH_BASE=ou=people,dc=example,dc=com
+OVERLEAF_LDAP_SEARCH_FILTER=(|(uid={{username}})(mail={{username}}))
+OVERLEAF_LDAP_BIND_DN=cn=ldap_reader,dc=example,dc=com
+OVERLEAF_LDAP_BIND_CREDENTIALS=GoodNewsEveryone
+OVERLEAF_LDAP_EMAIL_ATT=mail
+OVERLEAF_LDAP_FIRST_NAME_ATT=givenName
+OVERLEAF_LDAP_LAST_NAME_ATT=sn
+# OVERLEAF_LDAP_NAME_ATT=cn
+OVERLEAF_LDAP_SEARCH_ATTRIBUTES=["uid", "sn", "givenName", "mail"]
+
+OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN=true
+
+OVERLEAF_LDAP_PLACEHOLDER='Username or email address'
+
+OVERLEAF_LDAP_IS_ADMIN_ATT=mail
+OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE=admin@example.com
+
+OVERLEAF_LDAP_CONTACTS_FILTER=(gidNumber={{userProperty}})
+OVERLEAF_LDAP_CONTACTS_PROPERTY=gidNumber
+OVERLEAF_LDAP_CONTACTS_NON_LDAP_VALUE='*'
+```
+
+
+
+Deprecated variables
+
+**These variables will be removed soon**, use `OVERLEAF_LDAP_IS_ADMIN_ATT` and `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE` instead.
+
+The following variables are used to determine if the user has admin rights.
+Please note: the user gains admin status if the search result is not empty, not when the user is explicitly included in the search results.
+
+- `OVERLEAF_LDAP_ADMIN_SEARCH_BASE`
+ * Specifies the base DN from which to start searching for the admin group. If this variable is defined,
+ `OVERLEAF_LDAP_ADMIN_SEARCH_FILTER` must also be defined for the search to function properly.
+
+- `OVERLEAF_LDAP_ADMIN_SEARCH_FILTER`
+ * Defines the LDAP search filter used to identify the admin group. The placeholder `{{dn}}` within the filter
+ is replaced with the value of the property specified by `OVERLEAF_LDAP_ADMIN_DN_PROPERTY`. The placeholder `{{username}}` is also supported.
+
+- `OVERLEAF_LDAP_ADMIN_DN_PROPERTY`
+ * Specifies the property of the user object that will replace the '{{dn}}' placeholder
+ in the `OVERLEAF_LDAP_ADMIN_SEARCH_FILTER`, defaults to `dn`.
+
+- `OVERLEAF_LDAP_ADMIN_SEARCH_SCOPE`
+ * The scope of the LDAP search can be `base`, `one`, or `sub` (default)
+
+
+
Example
+
+In the following example admins are members of a group `admins`, the objectClass of the entry `admins` is `groupOfNames`:
+
+ OVERLEAF_LDAP_ADMIN_SEARCH_BASE='cn=admins,ou=group,dc=example,dc=com'
+ OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(member={{dn}})'
+
+In the following example admins are members of a group 'admins', the objectClass of the entry `admins` is `posixGroup`:
+
+ OVERLEAF_LDAP_ADMIN_SEARCH_BASE='cn=admins,ou=group,dc=example,dc=com'
+ OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(memberUid={{username}})'
+
+In the following example admins are users with UNIX gid=1234:
+
+ OVERLEAF_LDAP_ADMIN_SEARCH_BASE='ou=people,dc=example,dc=com'
+ OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(&(gidNumber=1234)(uid={{username}}))'
+
+In the following example admin is the user with `uid=someuser`:
+
+ OVERLEAF_LDAP_ADMIN_SEARCH_BASE='ou=people,dc=example,dc=com'
+ OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(&(uid=someuser)(uid={{username}}))'
+
+The filter
+
+ OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(uid=someuser)'
+
+where `someuser` is the uid of an existing user, will always produce a non-empty search result.
+As a result, **every user will be granted admin rights**, not just `someuser`, as one might expect.
+
+
+
+
+
+
+
SAML Authentication
+
+Internally, Overleaf SAML module uses the [passport-saml](https://github.com/node-saml/passport-saml) library, most of the following
+configuration options are passed through to `passport-saml`. If you are having issues configuring SAML, it is worth reading the README
+for `passport-saml` to get a feel for the configuration it expects.
+
+When using the SAML authentication method, a user is redirected to the Identity Provider (IdP) authentication site.
+If the IdP successfully authenticates the user, the Overleaf users database is checked for a record containing a `samlIdentifiers` field structured as follows:
+
+```
+samlIdentifiers: [
+ {
+ externalUserId: "...",
+ providerId: "1",
+ userIdAttribute: "..."
+ }
+]
+```
+The `externalUserId` must match the value of the property specified by `userIdAttribute` in the user profile returned by the IdP server.
+
+If no matching record is found, the database is searched for a user with the primary email address matching the email in the IdP user profile:
+
+- If such a user is found, the `hashedPassword` field is deleted to disable local authentication, and the `samlIdentifiers` field is added.
+- If no matching user is found, a new user is created with the email address and `samlIdentifiers` from the IdP profile.
+
+**Note:** Currently, only one SAML IdP is supported. The `providerId` field in `samlIdentifiers` is fixed to `'1'`.
+
+#### Environment Variables
+
+- `OVERLEAF_SAML_IDENTITY_SERVICE_NAME`
+ * Display name for the identity service, used on the login page (default: `Log in with SAML IdP`).
+
+- `OVERLEAF_SAML_USER_ID_FIELD`
+ * The value of this attribute will be used by Overleaf as the external user ID, defaults to `nameID`.
+
+- `OVERLEAF_SAML_EMAIL_FIELD`
+ * Name of the Email field in user profile, defaults to `nameID`.
+
+- `OVERLEAF_SAML_FIRST_NAME_FIELD`
+ * Name of the firstName field in user profile, defaults to `givenName`.
+
+- `OVERLEAF_SAML_LAST_NAME_FIELD`
+ * Name of the lastName field in user profile, defaults to `lastName`
+
+- `OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN`
+ * If set to `true`, updates the user `first_name` and `last_name` field on login,
+ and turn off the user details form on `/user/settings` page.
+
+- `OVERLEAF_SAML_ENTRYPOINT` **(required)**
+ * Entrypoint URL for the SAML identity service.
+
+ - Example: `https://idp.example.com/simplesaml/saml2/idp/SSOService.php`
+ - Azure Example: `https://login.microsoftonline.com/8b26b46a-6dd3-45c7-a104-f883f4db1f6b/saml2`
+
+- `OVERLEAF_SAML_ISSUER` **(required)**
+ * The Issuer name.
+
+- `OVERLEAF_SAML_AUDIENCE`
+ * Expected saml response Audience, defaults to value of `OVERLEAF_SAML_ISSUER`.
+
+- `OVERLEAF_SAML_IDP_CERT` **(required)**
+ * Path to a file containing the Identity Provider's public certificate, used to validate the signatures of incoming SAML responses. If the Identity Provider has multiple valid signing certificates, then
+ it can be a JSON array of paths to the certificates.
+
+ - Example (one certificate): `/overleaf/certs/idp_cert.pem`
+ - Example (multiple certificates): `["/overleaf/certs/idp_cert.pem", "/overleaf/certs/idp_cert_old.pem"]`
+
+- `OVERLEAF_SAML_PUBLIC_CERT`
+ * Path to a file containing public signing certificate used to embed in auth requests in order for the IdP to validate the signatures of the incoming SAML Request. It's required when setting up the [metadata endpoint](#metadata-for-the-identity-provider)
+ when the strategy is configured with a `OVERLEAF_SAML_PRIVATE_KEY`. A JSON array of paths to certificates can be provided to support certificate rotation. When supplying an array of certificates, the first entry in the array should match the
+ current `OVERLEAF_SAML_PRIVATE_KEY`. Additional entries in the array can be used to publish upcoming certificates to IdPs before changing the `OVERLEAF_SAML_PRIVATE_KEY`.
+
+- `OVERLEAF_SAML_PRIVATE_KEY`
+ * Path to a file containing a PEM-formatted private key matching the `OVERLEAF_SAML_PUBLIC_CERT` used to sign auth requests sent by passport-saml.
+
+- `OVERLEAF_SAML_DECRYPTION_CERT`
+ * Path to a file containing public certificate, used for the [metadata endpoint](#metadata-for-the-identity-provider).
+
+- `OVERLEAF_SAML_DECRYPTION_PVK`
+ * Path to a file containing private key matching the `OVERLEAF_SAML_DECRYPTION_CERT` that will be used to attempt to decrypt any encrypted assertions that are received.
+
+- `OVERLEAF_SAML_SIGNATURE_ALGORITHM`
+ * Optionally set the signature algorithm for signing requests,
+ valid values are 'sha1' (default), 'sha256' (prefered), 'sha512' (most secure, check if your IdP supports it).
+
+- `OVERLEAF_SAML_ADDITIONAL_PARAMS`
+ * JSON dictionary of additional query params to add to all requests.
+
+- `OVERLEAF_SAML_ADDITIONAL_AUTHORIZE_PARAMS`
+ * JSON dictionary of additional query params to add to 'authorize' requests.
+
+ - Example: `{"some_key": "some_value"}`
+
+- `OVERLEAF_SAML_IDENTIFIER_FORMAT`
+ * Name identifier format to request from the identity provider (default: `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`).
+ If using `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`, ensure the `OVERLEAF_SAML_EMAIL_FIELD` envirionment variable is defined.
+ If `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` is required, you must also define the `OVERLEAF_SAML_ID_FIELD` environment variable,
+ which can, for example, be set to the user's email address.
+
+- `OVERLEAF_SAML_ACCEPTED_CLOCK_SKEW_MS`
+ * Time in milliseconds of skew that is acceptable between client and server when checking OnBefore and NotOnOrAfter assertion
+ condition validity timestamps. Setting to -1 will disable checking these conditions entirely. Default is 0.
+
+- `OVERLEAF_SAML_ATTRIBUTE_CONSUMING_SERVICE_INDEX`
+ * `AttributeConsumingServiceIndex` attribute to add to AuthnRequest to instruct the IdP which attribute set to attach
+ to the response ([link](http://blog.aniljohn.com/2014/01/data-minimization-front-channel-saml-attribute-requests.html)).
+
+- `OVERLEAF_SAML_AUTHN_CONTEXT`
+ * JSON array of name identifier format values to request auth context. Default: `["urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"]`.
+
+- `OVERLEAF_SAML_FORCE_AUTHN`
+ * If `true`, the initial SAML request from the service provider specifies that the IdP should force re-authentication of the user,
+ even if they possess a valid session.
+
+- `OVERLEAF_SAML_DISABLE_REQUESTED_AUTHN_CONTEXT`
+ * If `true`, do not request a specific auth context. For example, you can this this to `true` to allow additional contexts such as password-less logins (`urn:oasis:names:tc:SAML:2.0:ac:classes:X509`). Support for additional contexts is dependant on your IdP.
+
+- `OVERLEAF_SAML_AUTHN_REQUEST_BINDING`
+ * If set to `HTTP-POST`, will request authentication from IdP via HTTP POST binding, otherwise defaults to HTTP-Redirect.
+
+- `OVERLEAF_SAML_VALIDATE_IN_RESPONSE_TO`
+ * If `always`, then InResponseTo will be validated from incoming SAML responses.
+ * If `never`, then InResponseTo won't be validated (default).
+ * If `ifPresent`, then InResponseTo will only be validated if present in the incoming SAML response.
+
+- `OVERLEAF_SAML_WANT_ASSERTIONS_SIGNED` and `OVERLEAF_SAML_WANT_AUTHN_RESPONSE_SIGNED`
+ * When set to `true` (default), Overleaf expects the SAML Assertions, respectively the entire SAML Authentication Response, to be signed by the IdP.
+ When both options are `false`, at least one of the assertions or the response must be signed.
+
+- `OVERLEAF_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS`
+ * Defines the expiration time when a Request ID generated for a SAML request will not be valid if seen
+ in a SAML response in the `InResponseTo` field. Default: 28800000 (8 hours).
+
+- `OVERLEAF_SAML_LOGOUT_URL`
+ * base address to call with logout requests (default: `entryPoint`).
+
+ - Example: `https://idp.example.com/simplesaml/saml2/idp/SingleLogoutService.php`
+
+- `OVERLEAF_SAML_ADDITIONAL_LOGOUT_PARAMS`
+ * JSON dictionary of additional query params to add to 'logout' requests.
+
+- `OVERLEAF_SAML_IS_ADMIN_FIELD` and `OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE`
+ * When both environment variables are set, the login process updates `user.isAdmin = true` if the profile returned by the SAML IdP contains the attribute specified by
+ `OVERLEAF_SAML_IS_ADMIN_FIELD` and its value either matches `OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE` or is an array containing `OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE`,
+ otherwise `user.isAdmin` is set to `false`. If either of these variables is not set, then the admin status is only set to `true` during admin user
+ creation in Launchpad.
+
+#### Metadata for the Identity Provider
+
+The current version of Overleaf CE includes and endpoint to retrieve Service Provider Metadata: `http://my-overleaf-instance.com/saml/meta`
+
+The Identity Provider will need to be configured to recognize the Overleaf server as a "Service Provider". Consult the documentation for your SAML server for instructions on how to do this.
+
+Below is an example of appropriate Service Provider metadata:
+
+
+
ol-meta.xml
+
+```
+
+
+
+
+
+
+ MII...
+[skipped]
+
+
+
+
+
+
+
+ MII...
+[skipped]
+
+
+
+
+
+
+
+
+
+ urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
+
+
+
+
+```
+
+
+Note the certificates, `AssertionConsumerService.Location`, `SingleLogoutService.Location` and `EntityDescriptor.entityID`
+and set as appropriate in your IdP configuration, or send the metadata file to the IdP admin.
+
+
+
Sample variables.env file
+
+```
+OVERLEAF_APP_NAME="Our Overleaf Instance"
+
+ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url
+
+# Enables Thumbnail generation using ImageMagick
+ENABLE_CONVERSIONS=true
+
+# Disables email confirmation requirement
+EMAIL_CONFIRMATION_DISABLED=true
+
+## Nginx
+# NGINX_WORKER_PROCESSES=4
+# NGINX_WORKER_CONNECTIONS=768
+
+## Set for TLS via nginx-proxy
+# OVERLEAF_BEHIND_PROXY=true
+# OVERLEAF_SECURE_COOKIE=true
+
+OVERLEAF_SITE_URL=http://my-overleaf-instance.com
+OVERLEAF_NAV_TITLE=Our Overleaf Instance
+# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png
+OVERLEAF_ADMIN_EMAIL=support@example.com
+
+OVERLEAF_LEFT_FOOTER=[{"text": "Contact your support team", "url": "mailto:support@example.com"}]
+OVERLEAF_RIGHT_FOOTER=[{"text":"Hello, I am on the Right", "url":"https://github.com/yu-i-i/overleaf-cep"}]
+
+OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com
+OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com
+OVERLEAF_EMAIL_SMTP_PORT=587
+OVERLEAF_EMAIL_SMTP_SECURE=false
+# OVERLEAF_EMAIL_SMTP_USER=
+# OVERLEAF_EMAIL_SMTP_PASS=
+# OVERLEAF_EMAIL_SMTP_NAME=
+OVERLEAF_EMAIL_SMTP_LOGGER=false
+OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true
+OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false
+OVERLEAF_CUSTOM_EMAIL_FOOTER=This system is run by department x
+
+OVERLEAF_PROXY_LEARN=true
+NAV_HIDE_POWERED_BY=true
+
+#################
+## SAML for CE ##
+#################
+
+EXTERNAL_AUTH=saml
+OVERLEAF_SAML_IDENTITY_SERVICE_NAME='Log in with My IdP'
+OVERLEAF_SAML_EMAIL_FIELD=mail
+OVERLEAF_SAML_FIRST_NAME_FIELD=givenName
+OVERLEAF_SAML_LAST_NAME_FIELD=sn
+OVERLEAF_SAML_ENTRYPOINT=https://idp.example.com/simplesamlphp/saml2/idp/SSOService.php
+OVERLEAF_SAML_CALLBACK_URL=https://my-overleaf-instance.com/saml/login/callback
+OVERLEAF_SAML_LOGOUT_URL=https://idp.example.com/simplesamlphp/saml2/idp/SingleLogoutService.php
+OVERLEAF_SAML_LOGOUT_CALLBACK_URL=https://my-overleaf-instance.com/saml/logout/callback
+OVERLEAF_SAML_ISSUER=MyOverleaf
+OVERLEAF_SAML_IDP_CERT=/overleaf/certs/idp_cert.pem
+OVERLEAF_SAML_PUBLIC_CERT=/overleaf/certs/myol_cert.pem
+OVERLEAF_SAML_PRIVATE_KEY=/overleaf/certs/myol_key.pem
+OVERLEAF_SAML_DECRYPTION_CERT=/overleaf/certs/myol_decr_cert.pem
+OVERLEAF_SAML_DECRYPTION_PVK=/overleaf/certs/myol_decr_key.pem
+OVERLEAF_SAML_IS_ADMIN_FIELD=mail
+OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE=overleaf.admin@example.com
+```
+
+
+
+
+
OIDC Authentication
+
+Internally, Overleaf OIDC module uses the [passport-openidconnect](https://github.com/jaredhanson/passport-openidconnect) library.
+If you are having issues configuring OpenID Connect, it is worth reading the README for `passport-openidconnect` to get a feel for the configuration it expects.
+
+
+When using the OIDC authentication method, a user is redirected to the Identity Provider (IdP) authentication site.
+If the IdP successfully authenticates the user, the Overleaf users database is checked for a record containing a `thirdPartyIdentifiers` field structured as follows:
+
+```
+thirdPartyIdentifiers: [
+ {
+ externalUserId: "...",
+ externalData: null,
+ providerId: "..."
+ }
+]
+```
+
+The `externalUserId` must match the user ID in the profile returned by the IdP server (see the `OVERLEAF_OIDC_USER_ID_FIELD` environment variable), and `providerId`
+must match the ID of the OIDC provider (see the `OVERLEAF_OIDC_PROVIDER_ID`).
+
+If no matching record is found, the database is searched for a user with the primary email address matching the email in the IdP user profile:
+- If such a user is found, the `thirdPartyIdentifiers` field is updated.
+- If no matching user is found, a new user is created with the email address and `thirdPartyIdentifiers` from the IdP profile.
+
+In both cases, the user is said to be 'linked' to the external OIDC user. The user can be unlinked from the OIDC provider on the `/user/settings` page.
+
+
+#### Environment Variables
+
+The values of the following five required variables can be found using `.well-known/openid-configuration` endpoint of your OpenID Provider (OP).
+
+- `OVERLEAF_OIDC_ISSUER` **(required)**
+
+- `OVERLEAF_OIDC_AUTHORIZATION_URL` **(required)**
+
+- `OVERLEAF_OIDC_TOKEN_URL` **(required)**
+
+- `OVERLEAF_OIDC_USER_INFO_URL` **(required)**
+
+- `OVERLEAF_OIDC_LOGOUT_URL` **(required)**
+
+The values of the following two required variables will be provided by the admin of your OP
+
+- `OVERLEAF_OIDC_CLIENT_ID` **(required)**
+
+- `OVERLEAF_OIDC_CLIENT_SECRET` **(required)**
+
+- `OVERLEAF_OIDC_SCOPE`
+ * Default: `openid profile email`
+
+- `OVERLEAF_OIDC_PROVIDER_ID`
+ * Arbitrary ID of the OP, defaults to `oidc`.
+
+- `OVERLEAF_OIDC_PROVIDER_NAME`
+ * The name of the OP, used in the `Linked Accounts` section of the `/user/settings` page, defaults to `OIDC Provider`.
+
+- `OVERLEAF_OIDC_IDENTITY_SERVICE_NAME`
+ * Display name for the identity service, used on the login page (default: `Log in with $OVERLEAF_OIDC_PROVIDER_NAME`).
+
+- `OVERLEAF_OIDC_PROVIDER_DESCRIPTION`
+ * Description of OP, used in the `Linked Accounts` section (default: `Log in with $OVERLEAF_OIDC_PROVIDER_NAME`).
+
+- `OVERLEAF_OIDC_PROVIDER_INFO_LINK`
+ * `Learn more` URL in the OP description, default: no `Learn more` link in the description.
+
+- `OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED`
+ * Do not show OP on the `/user/settings` page, if the user's account is not linked with the OP, default `false`.
+
+- `OVERLEAF_OIDC_USER_ID_FIELD`
+ * The value of this attribute will be used by Overleaf as the external user ID, defaults to `id`.
+ Other possible reasonable values are `email` and `username` (corresponding to `preferred_username` OIDC claim).
+
+- `OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN`
+ * If set to `true`, updates the user `first_name` and `last_name` field on login,
+ and disables the user details form on `/user/settings` page.
+
+- `OVERLEAF_OIDC_IS_ADMIN_FIELD` and `OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE`
+ * When both environment variables are set, the login process updates `user.isAdmin = true` if the profile returned by the OP contains the attribute specified by
+ `OVERLEAF_OIDC_IS_ADMIN_FIELD` and its value matches `OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE`, otherwise `user.isAdmin` is set to `false`.
+ If `OVERLEAF_OIDC_IS_ADMIN_FIELD` is `email` then the value of the attribute `emails[0].value` is used for match checking.
+
+The redirect URL for your OpenID Provider is `https://my-overleaf-instance.com/oidc/login/callback`.
+
+
+
Sample variables.env file
+
+```
+OVERLEAF_APP_NAME="Our Overleaf Instance"
+
+ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url
+
+# Enables Thumbnail generation using ImageMagick
+ENABLE_CONVERSIONS=true
+
+# Disables email confirmation requirement
+EMAIL_CONFIRMATION_DISABLED=true
+
+## Nginx
+# NGINX_WORKER_PROCESSES=4
+# NGINX_WORKER_CONNECTIONS=768
+
+## Set for TLS via nginx-proxy
+# OVERLEAF_BEHIND_PROXY=true
+# OVERLEAF_SECURE_COOKIE=true
+
+OVERLEAF_SITE_URL=http://my-overleaf-instance.com
+OVERLEAF_NAV_TITLE=Our Overleaf Instance
+# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png
+OVERLEAF_ADMIN_EMAIL=support@example.com
+
+OVERLEAF_LEFT_FOOTER=[{"text": "Contact your support team", "url": "mailto:support@example.com"}]
+OVERLEAF_RIGHT_FOOTER=[{"text":"Hello, I am on the Right", "url":"https://github.com/yu-i-i/overleaf-cep"}]
+
+OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com
+OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com
+OVERLEAF_EMAIL_SMTP_PORT=587
+OVERLEAF_EMAIL_SMTP_SECURE=false
+# OVERLEAF_EMAIL_SMTP_USER=
+# OVERLEAF_EMAIL_SMTP_PASS=
+# OVERLEAF_EMAIL_SMTP_NAME=
+OVERLEAF_EMAIL_SMTP_LOGGER=false
+OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true
+OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false
+OVERLEAF_CUSTOM_EMAIL_FOOTER=This system is run by department x
+
+OVERLEAF_PROXY_LEARN=true
+NAV_HIDE_POWERED_BY=true
+
+#################
+## OIDC for CE ##
+#################
+
+EXTERNAL_AUTH=oidc
+
+OVERLEAF_OIDC_PROVIDER_ID=oidc
+OVERLEAF_OIDC_ISSUER=https://keycloak.provider.com/realms/example
+OVERLEAF_OIDC_AUTHORIZATION_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/auth
+OVERLEAF_OIDC_TOKEN_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/token
+OVERLEAF_OIDC_USER_INFO_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/userinfo
+OVERLEAF_OIDC_LOGOUT_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/logout
+OVERLEAF_OIDC_CLIENT_ID=Overleaf-OIDC
+OVERLEAF_OIDC_CLIENT_SECRET=DoNotUseThisATGgaAcTgCcATgGATTACAagGtTCaGcGTAG
+OVERLEAF_OIDC_IDENTITY_SERVICE_NAME='Log in with Keycloak OIDC Provider'
+OVERLEAF_OIDC_PROVIDER_NAME=OIDC Keycloak Provider
+OVERLEAF_OIDC_PROVIDER_INFO_LINK=https://openid.net
+OVERLEAF_OIDC_IS_ADMIN_FIELD=email
+OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE=overleaf.admin@example.com
+OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN=false
+```
+
+
## Overleaf Docker Image
This repo contains two dockerfiles, [`Dockerfile-base`](server-ce/Dockerfile-base), which builds the
-`sharelatex/sharelatex-base:ext-ce` image, and [`Dockerfile`](server-ce/Dockerfile) which builds the
-`sharelatex/sharelatex:ext-ce` image.
+`sharelatex/sharelatex-base` image, and [`Dockerfile`](server-ce/Dockerfile) which builds the
+`sharelatex/sharelatex` (or "community") image.
The Base image generally contains the basic dependencies like `wget`, plus `texlive`.
-This is split out because it's a pretty heavy set of
+We split this out because it's a pretty heavy set of
dependencies, and it's nice to not have to rebuild all of that every time.
The `sharelatex/sharelatex` image extends the base image and adds the actual Overleaf code
@@ -67,16 +1050,17 @@ and services.
Use `make build-base` and `make build-community` from `server-ce/` to build these images.
-The [Phusion base-image](https://github.com/phusion/baseimage-docker)
-(which is extended by the `base` image) provides a VM-like container
+We use the [Phusion base-image](https://github.com/phusion/baseimage-docker)
+(which is extended by our `base` image) to provide us with a VM-like container
in which to run the Overleaf services. Baseimage uses the `runit` service
-manager to manage services, and init scripts from the `server-ce/runit`
-folder are added.
+manager to manage services, and we add our init-scripts from the `server-ce/runit`
+folder.
## Authors
-[The Overleaf Team](https://www.overleaf.com/about)
-[yu-i-i](https://github.com/yu-i-i/overleaf-cep) — Extensions for CE unless otherwise noted
+[The Overleaf Team](https://www.overleaf.com/about)
+
+Extensions for CE by: [yu-i-i](https://github.com/yu-i-i/overleaf-cep)
## License
diff --git a/develop/README.md b/develop/README.md
index 8e3f89862c..14f7354572 100644
--- a/develop/README.md
+++ b/develop/README.md
@@ -42,7 +42,7 @@ To do this, use the included `bin/dev` script:
bin/dev
```
-This will start all services using `node --watch`, which will automatically monitor the code and restart the services as necessary.
+This will start all services using `nodemon`, which will automatically monitor the code and restart the services as necessary.
To improve performance, you can start only a subset of the services in development mode by providing a space-separated list to the `bin/dev` script:
diff --git a/develop/dev.env b/develop/dev.env
index b003e4e0eb..2ccfef7052 100644
--- a/develop/dev.env
+++ b/develop/dev.env
@@ -6,18 +6,15 @@ DOCUMENT_UPDATER_HOST=document-updater
FILESTORE_HOST=filestore
GRACEFUL_SHUTDOWN_DELAY_SECONDS=0
HISTORY_V1_HOST=history-v1
-HISTORY_REDIS_HOST=redis
LISTEN_ADDRESS=0.0.0.0
MONGO_HOST=mongo
MONGO_URL=mongodb://mongo/sharelatex?directConnection=true
NOTIFICATIONS_HOST=notifications
PROJECT_HISTORY_HOST=project-history
-QUEUES_REDIS_HOST=redis
REALTIME_HOST=real-time
REDIS_HOST=redis
REFERENCES_HOST=references
SESSION_SECRET=foo
-V1_HISTORY_HOST=history-v1
WEBPACK_HOST=webpack
WEB_API_PASSWORD=overleaf
WEB_API_USER=overleaf
diff --git a/develop/docker-compose.dev.yml b/develop/docker-compose.dev.yml
index 65e15ef07b..05844136a0 100644
--- a/develop/docker-compose.dev.yml
+++ b/develop/docker-compose.dev.yml
@@ -124,7 +124,7 @@ services:
- ../services/references/app.js:/overleaf/services/references/app.js
web:
- command: ["node", "--watch", "app.mjs", "--watch-locales"]
+ command: ["node", "--watch", "app.js", "--watch-locales"]
environment:
- NODE_OPTIONS=--inspect=0.0.0.0:9229
ports:
diff --git a/develop/docker-compose.yml b/develop/docker-compose.yml
index e5b84c38b3..392cb220cb 100644
--- a/develop/docker-compose.yml
+++ b/develop/docker-compose.yml
@@ -1,5 +1,6 @@
volumes:
clsi-cache:
+ clsi-output:
filestore-public-files:
filestore-template-files:
filestore-uploads:
@@ -25,16 +26,15 @@ services:
env_file:
- dev.env
environment:
+ - DOCKER_RUNNER=true
- TEXLIVE_IMAGE=texlive-full # docker build texlive -t texlive-full
- - SANDBOXED_COMPILES=true
- - SANDBOXED_COMPILES_HOST_DIR_COMPILES=${PWD}/compiles
- - SANDBOXED_COMPILES_HOST_DIR_OUTPUT=${PWD}/output
+ - COMPILES_HOST_DIR=${PWD}/compiles
user: root
volumes:
- ${PWD}/compiles:/overleaf/services/clsi/compiles
- - ${PWD}/output:/overleaf/services/clsi/output
- ${DOCKER_SOCKET_PATH:-/var/run/docker.sock}:/var/run/docker.sock
- clsi-cache:/overleaf/services/clsi/cache
+ - clsi-output:/overleaf/services/clsi/output
contacts:
build:
diff --git a/doc/logo.png b/doc/logo.png
index f154ac0cca..106926b095 100644
Binary files a/doc/logo.png and b/doc/logo.png differ
diff --git a/docker-compose.yml b/docker-compose.yml
index 962adfb5d8..2beba88d85 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -73,19 +73,11 @@ services:
## Server Pro ##
################
- ## The Community Edition is intended for use in environments where all users are trusted and is not appropriate for
- ## scenarios where isolation of users is required. Sandboxed Compiles are not available in the Community Edition,
- ## so the following environment variables must be commented out to avoid compile issues.
- ##
- ## Sandboxed Compiles: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/sandboxed-compiles
+ ## Sandboxed Compiles: https://github.com/overleaf/overleaf/wiki/Server-Pro:-Sandboxed-Compiles
SANDBOXED_COMPILES: 'true'
- ### Bind-mount source for /var/lib/overleaf/data/compiles inside the container.
- SANDBOXED_COMPILES_HOST_DIR_COMPILES: '/home/user/sharelatex_data/data/compiles'
- ### Bind-mount source for /var/lib/overleaf/data/output inside the container.
- SANDBOXED_COMPILES_HOST_DIR_OUTPUT: '/home/user/sharelatex_data/data/output'
- ### Backwards compatibility (before Server Pro 5.5)
- DOCKER_RUNNER: 'true'
SANDBOXED_COMPILES_SIBLING_CONTAINERS: 'true'
+ ### Bind-mount source for /var/lib/overleaf/data/compiles inside the container.
+ SANDBOXED_COMPILES_HOST_DIR: '/home/user/sharelatex_data/data/compiles'
## Works with test LDAP server shown at bottom of docker compose
# OVERLEAF_LDAP_URL: 'ldap://ldap:389'
diff --git a/libraries/access-token-encryptor/.dockerignore b/libraries/access-token-encryptor/.dockerignore
new file mode 100644
index 0000000000..c2658d7d1b
--- /dev/null
+++ b/libraries/access-token-encryptor/.dockerignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/libraries/access-token-encryptor/.gitignore b/libraries/access-token-encryptor/.gitignore
new file mode 100644
index 0000000000..66936c4121
--- /dev/null
+++ b/libraries/access-token-encryptor/.gitignore
@@ -0,0 +1,46 @@
+compileFolder
+
+Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store?
+ehthumbs.db
+Icon?
+Thumbs.db
+
+/node_modules/*
+data/*/*
+
+**.swp
+
+/log.json
+hash_folder
+
+.npmrc
diff --git a/libraries/access-token-encryptor/.nvmrc b/libraries/access-token-encryptor/.nvmrc
index fc37597bcc..0254b1e633 100644
--- a/libraries/access-token-encryptor/.nvmrc
+++ b/libraries/access-token-encryptor/.nvmrc
@@ -1 +1 @@
-22.17.0
+20.18.2
diff --git a/libraries/access-token-encryptor/buildscript.txt b/libraries/access-token-encryptor/buildscript.txt
index 8f08720e7e..967c3063ad 100644
--- a/libraries/access-token-encryptor/buildscript.txt
+++ b/libraries/access-token-encryptor/buildscript.txt
@@ -1,10 +1,10 @@
access-token-encryptor
--dependencies=None
---docker-repos=us-east1-docker.pkg.dev/overleaf-ops/ol-docker
+--docker-repos=gcr.io/overleaf-ops
--env-add=
--env-pass-through=
--esmock-loader=False
--is-library=True
---node-version=22.17.0
+--node-version=20.18.2
--public-repo=False
---script-version=4.7.0
+--script-version=4.5.0
diff --git a/libraries/fetch-utils/.dockerignore b/libraries/fetch-utils/.dockerignore
new file mode 100644
index 0000000000..c2658d7d1b
--- /dev/null
+++ b/libraries/fetch-utils/.dockerignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/libraries/fetch-utils/.gitignore b/libraries/fetch-utils/.gitignore
new file mode 100644
index 0000000000..edb0f85350
--- /dev/null
+++ b/libraries/fetch-utils/.gitignore
@@ -0,0 +1,3 @@
+
+# managed by monorepo$ bin/update_build_scripts
+.npmrc
diff --git a/libraries/fetch-utils/.nvmrc b/libraries/fetch-utils/.nvmrc
index fc37597bcc..0254b1e633 100644
--- a/libraries/fetch-utils/.nvmrc
+++ b/libraries/fetch-utils/.nvmrc
@@ -1 +1 @@
-22.17.0
+20.18.2
diff --git a/libraries/fetch-utils/buildscript.txt b/libraries/fetch-utils/buildscript.txt
index 7008a533a6..716d3f0d5c 100644
--- a/libraries/fetch-utils/buildscript.txt
+++ b/libraries/fetch-utils/buildscript.txt
@@ -1,10 +1,10 @@
fetch-utils
--dependencies=None
---docker-repos=us-east1-docker.pkg.dev/overleaf-ops/ol-docker
+--docker-repos=gcr.io/overleaf-ops
--env-add=
--env-pass-through=
--esmock-loader=False
--is-library=True
---node-version=22.17.0
+--node-version=20.18.2
--public-repo=False
---script-version=4.7.0
+--script-version=4.5.0
diff --git a/libraries/fetch-utils/index.js b/libraries/fetch-utils/index.js
index 60e8180c7d..643dcc752b 100644
--- a/libraries/fetch-utils/index.js
+++ b/libraries/fetch-utils/index.js
@@ -23,11 +23,11 @@ async function fetchJson(url, opts = {}) {
}
async function fetchJsonWithResponse(url, opts = {}) {
- const { fetchOpts, detachSignal } = parseOpts(opts)
+ const { fetchOpts } = parseOpts(opts)
fetchOpts.headers = fetchOpts.headers ?? {}
fetchOpts.headers.Accept = fetchOpts.headers.Accept ?? 'application/json'
- const response = await performRequest(url, fetchOpts, detachSignal)
+ const response = await performRequest(url, fetchOpts)
if (!response.ok) {
const body = await maybeGetResponseBody(response)
throw new RequestFailedError(url, opts, response, body)
@@ -53,8 +53,8 @@ async function fetchStream(url, opts = {}) {
}
async function fetchStreamWithResponse(url, opts = {}) {
- const { fetchOpts, abortController, detachSignal } = parseOpts(opts)
- const response = await performRequest(url, fetchOpts, detachSignal)
+ const { fetchOpts, abortController } = parseOpts(opts)
+ const response = await performRequest(url, fetchOpts)
if (!response.ok) {
const body = await maybeGetResponseBody(response)
@@ -76,8 +76,8 @@ async function fetchStreamWithResponse(url, opts = {}) {
* @throws {RequestFailedError} if the response has a failure status code
*/
async function fetchNothing(url, opts = {}) {
- const { fetchOpts, detachSignal } = parseOpts(opts)
- const response = await performRequest(url, fetchOpts, detachSignal)
+ const { fetchOpts } = parseOpts(opts)
+ const response = await performRequest(url, fetchOpts)
if (!response.ok) {
const body = await maybeGetResponseBody(response)
throw new RequestFailedError(url, opts, response, body)
@@ -108,9 +108,9 @@ async function fetchRedirect(url, opts = {}) {
* @throws {RequestFailedError} if the response has a non redirect status code or missing Location header
*/
async function fetchRedirectWithResponse(url, opts = {}) {
- const { fetchOpts, detachSignal } = parseOpts(opts)
+ const { fetchOpts } = parseOpts(opts)
fetchOpts.redirect = 'manual'
- const response = await performRequest(url, fetchOpts, detachSignal)
+ const response = await performRequest(url, fetchOpts)
if (response.status < 300 || response.status >= 400) {
const body = await maybeGetResponseBody(response)
throw new RequestFailedError(url, opts, response, body)
@@ -142,8 +142,8 @@ async function fetchString(url, opts = {}) {
}
async function fetchStringWithResponse(url, opts = {}) {
- const { fetchOpts, detachSignal } = parseOpts(opts)
- const response = await performRequest(url, fetchOpts, detachSignal)
+ const { fetchOpts } = parseOpts(opts)
+ const response = await performRequest(url, fetchOpts)
if (!response.ok) {
const body = await maybeGetResponseBody(response)
throw new RequestFailedError(url, opts, response, body)
@@ -178,14 +178,13 @@ function parseOpts(opts) {
const abortController = new AbortController()
fetchOpts.signal = abortController.signal
- let detachSignal = () => {}
if (opts.signal) {
- detachSignal = abortOnSignal(abortController, opts.signal)
+ abortOnSignal(abortController, opts.signal)
}
if (opts.body instanceof Readable) {
abortOnDestroyedRequest(abortController, fetchOpts.body)
}
- return { fetchOpts, abortController, detachSignal }
+ return { fetchOpts, abortController }
}
function setupJsonBody(fetchOpts, json) {
@@ -209,9 +208,6 @@ function abortOnSignal(abortController, signal) {
abortController.abort(signal.reason)
}
signal.addEventListener('abort', listener)
- return () => {
- signal.removeEventListener('abort', listener)
- }
}
function abortOnDestroyedRequest(abortController, stream) {
@@ -230,12 +226,11 @@ function abortOnDestroyedResponse(abortController, response) {
})
}
-async function performRequest(url, fetchOpts, detachSignal) {
+async function performRequest(url, fetchOpts) {
let response
try {
response = await fetch(url, fetchOpts)
} catch (err) {
- detachSignal()
if (fetchOpts.body instanceof Readable) {
fetchOpts.body.destroy()
}
@@ -244,7 +239,6 @@ async function performRequest(url, fetchOpts, detachSignal) {
method: fetchOpts.method ?? 'GET',
})
}
- response.body.on('close', detachSignal)
if (fetchOpts.body instanceof Readable) {
response.body.on('close', () => {
if (!fetchOpts.body.readableEnded) {
diff --git a/libraries/fetch-utils/test/unit/FetchUtilsTests.js b/libraries/fetch-utils/test/unit/FetchUtilsTests.js
index 691e90778d..e9fd0ff231 100644
--- a/libraries/fetch-utils/test/unit/FetchUtilsTests.js
+++ b/libraries/fetch-utils/test/unit/FetchUtilsTests.js
@@ -1,9 +1,6 @@
const { expect } = require('chai')
-const fs = require('node:fs')
-const events = require('node:events')
const { FetchError, AbortError } = require('node-fetch')
const { Readable } = require('node:stream')
-const { pipeline } = require('node:stream/promises')
const { once } = require('node:events')
const { TestServer } = require('./helpers/TestServer')
const selfsigned = require('selfsigned')
@@ -206,31 +203,6 @@ describe('fetch-utils', function () {
).to.be.rejectedWith(AbortError)
expect(stream.destroyed).to.be.true
})
-
- it('detaches from signal on success', async function () {
- const signal = AbortSignal.timeout(10_000)
- for (let i = 0; i < 20; i++) {
- const s = await fetchStream(this.url('/hello'), { signal })
- expect(events.getEventListeners(signal, 'abort')).to.have.length(1)
- await pipeline(s, fs.createWriteStream('/dev/null'))
- expect(events.getEventListeners(signal, 'abort')).to.have.length(0)
- }
- })
-
- it('detaches from signal on error', async function () {
- const signal = AbortSignal.timeout(10_000)
- for (let i = 0; i < 20; i++) {
- try {
- await fetchStream(this.url('/500'), { signal })
- } catch (err) {
- if (err instanceof RequestFailedError && err.response.status === 500)
- continue
- throw err
- } finally {
- expect(events.getEventListeners(signal, 'abort')).to.have.length(0)
- }
- }
- })
})
describe('fetchNothing', function () {
@@ -419,16 +391,9 @@ async function* infiniteIterator() {
async function abortOnceReceived(func, server) {
const controller = new AbortController()
const promise = func(controller.signal)
- expect(events.getEventListeners(controller.signal, 'abort')).to.have.length(1)
await once(server.events, 'request-received')
controller.abort()
- try {
- return await promise
- } finally {
- expect(events.getEventListeners(controller.signal, 'abort')).to.have.length(
- 0
- )
- }
+ return await promise
}
async function expectRequestAborted(req) {
diff --git a/libraries/logger/.dockerignore b/libraries/logger/.dockerignore
new file mode 100644
index 0000000000..c2658d7d1b
--- /dev/null
+++ b/libraries/logger/.dockerignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/libraries/logger/.gitignore b/libraries/logger/.gitignore
new file mode 100644
index 0000000000..2006c875a4
--- /dev/null
+++ b/libraries/logger/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+
+.npmrc
diff --git a/libraries/logger/.nvmrc b/libraries/logger/.nvmrc
index fc37597bcc..0254b1e633 100644
--- a/libraries/logger/.nvmrc
+++ b/libraries/logger/.nvmrc
@@ -1 +1 @@
-22.17.0
+20.18.2
diff --git a/libraries/logger/buildscript.txt b/libraries/logger/buildscript.txt
index e2520c4800..7db4c0c4c3 100644
--- a/libraries/logger/buildscript.txt
+++ b/libraries/logger/buildscript.txt
@@ -1,10 +1,10 @@
logger
--dependencies=None
---docker-repos=us-east1-docker.pkg.dev/overleaf-ops/ol-docker
+--docker-repos=gcr.io/overleaf-ops
--env-add=
--env-pass-through=
--esmock-loader=False
--is-library=True
---node-version=22.17.0
+--node-version=20.18.2
--public-repo=False
---script-version=4.7.0
+--script-version=4.5.0
diff --git a/libraries/metrics/.dockerignore b/libraries/metrics/.dockerignore
new file mode 100644
index 0000000000..c2658d7d1b
--- /dev/null
+++ b/libraries/metrics/.dockerignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/libraries/metrics/.gitignore b/libraries/metrics/.gitignore
new file mode 100644
index 0000000000..2006c875a4
--- /dev/null
+++ b/libraries/metrics/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+
+.npmrc
diff --git a/libraries/metrics/.nvmrc b/libraries/metrics/.nvmrc
index fc37597bcc..0254b1e633 100644
--- a/libraries/metrics/.nvmrc
+++ b/libraries/metrics/.nvmrc
@@ -1 +1 @@
-22.17.0
+20.18.2
diff --git a/libraries/metrics/buildscript.txt b/libraries/metrics/buildscript.txt
index d1e272c356..2919cb8335 100644
--- a/libraries/metrics/buildscript.txt
+++ b/libraries/metrics/buildscript.txt
@@ -1,10 +1,10 @@
metrics
--dependencies=None
---docker-repos=us-east1-docker.pkg.dev/overleaf-ops/ol-docker
+--docker-repos=gcr.io/overleaf-ops
--env-add=
--env-pass-through=
--esmock-loader=False
--is-library=True
---node-version=22.17.0
+--node-version=20.18.2
--public-repo=False
---script-version=4.7.0
+--script-version=4.5.0
diff --git a/libraries/metrics/initialize.js b/libraries/metrics/initialize.js
index f1a77666c7..1028ee06c3 100644
--- a/libraries/metrics/initialize.js
+++ b/libraries/metrics/initialize.js
@@ -5,8 +5,6 @@
* before any other module to support code instrumentation.
*/
-const metricsModuleImportStartTime = performance.now()
-
const APP_NAME = process.env.METRICS_APP_NAME || 'unknown'
const BUILD_VERSION = process.env.BUILD_VERSION
const ENABLE_PROFILE_AGENT = process.env.ENABLE_PROFILE_AGENT === 'true'
@@ -105,5 +103,3 @@ function recordProcessStart() {
const metrics = require('.')
metrics.inc('process_startup')
}
-
-module.exports = { metricsModuleImportStartTime }
diff --git a/libraries/metrics/package.json b/libraries/metrics/package.json
index 19b566c2b0..384e58cfe5 100644
--- a/libraries/metrics/package.json
+++ b/libraries/metrics/package.json
@@ -9,7 +9,7 @@
"main": "index.js",
"dependencies": {
"@google-cloud/opentelemetry-cloud-trace-exporter": "^2.1.0",
- "@google-cloud/profiler": "^6.0.3",
+ "@google-cloud/profiler": "^6.0.0",
"@opentelemetry/api": "^1.4.1",
"@opentelemetry/auto-instrumentations-node": "^0.39.1",
"@opentelemetry/exporter-trace-otlp-http": "^0.41.2",
diff --git a/libraries/mongo-utils/.dockerignore b/libraries/mongo-utils/.dockerignore
new file mode 100644
index 0000000000..c2658d7d1b
--- /dev/null
+++ b/libraries/mongo-utils/.dockerignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/libraries/mongo-utils/.gitignore b/libraries/mongo-utils/.gitignore
new file mode 100644
index 0000000000..edb0f85350
--- /dev/null
+++ b/libraries/mongo-utils/.gitignore
@@ -0,0 +1,3 @@
+
+# managed by monorepo$ bin/update_build_scripts
+.npmrc
diff --git a/libraries/mongo-utils/.nvmrc b/libraries/mongo-utils/.nvmrc
index fc37597bcc..0254b1e633 100644
--- a/libraries/mongo-utils/.nvmrc
+++ b/libraries/mongo-utils/.nvmrc
@@ -1 +1 @@
-22.17.0
+20.18.2
diff --git a/libraries/mongo-utils/batchedUpdate.js b/libraries/mongo-utils/batchedUpdate.js
index 41af41f0d4..5e97f45aca 100644
--- a/libraries/mongo-utils/batchedUpdate.js
+++ b/libraries/mongo-utils/batchedUpdate.js
@@ -16,7 +16,6 @@ let VERBOSE_LOGGING
let BATCH_RANGE_START
let BATCH_RANGE_END
let BATCH_MAX_TIME_SPAN_IN_MS
-let BATCHED_UPDATE_RUNNING = false
/**
* @typedef {import("mongodb").Collection} Collection
@@ -35,7 +34,6 @@ let BATCHED_UPDATE_RUNNING = false
* @property {string} [BATCH_RANGE_START]
* @property {string} [BATCH_SIZE]
* @property {string} [VERBOSE_LOGGING]
- * @property {(progress: string) => Promise} [trackProgress]
*/
/**
@@ -211,71 +209,59 @@ async function batchedUpdate(
update,
projection,
findOptions,
- batchedUpdateOptions = {}
+ batchedUpdateOptions
) {
- // only a single batchedUpdate can run at a time due to global variables
- if (BATCHED_UPDATE_RUNNING) {
- throw new Error('batchedUpdate is already running')
+ ID_EDGE_PAST = await getIdEdgePast(collection)
+ if (!ID_EDGE_PAST) {
+ console.warn(
+ `The collection ${collection.collectionName} appears to be empty.`
+ )
+ return 0
}
- try {
- BATCHED_UPDATE_RUNNING = true
- ID_EDGE_PAST = await getIdEdgePast(collection)
- if (!ID_EDGE_PAST) {
- console.warn(
- `The collection ${collection.collectionName} appears to be empty.`
- )
- return 0
- }
- refreshGlobalOptionsForBatchedUpdate(batchedUpdateOptions)
- const { trackProgress = async progress => console.warn(progress) } =
- batchedUpdateOptions
+ refreshGlobalOptionsForBatchedUpdate(batchedUpdateOptions)
- findOptions = findOptions || {}
- findOptions.readPreference = READ_PREFERENCE_SECONDARY
+ findOptions = findOptions || {}
+ findOptions.readPreference = READ_PREFERENCE_SECONDARY
- projection = projection || { _id: 1 }
- let nextBatch
- let updated = 0
- let start = BATCH_RANGE_START
+ projection = projection || { _id: 1 }
+ let nextBatch
+ let updated = 0
+ let start = BATCH_RANGE_START
- while (start !== BATCH_RANGE_END) {
- let end = getNextEnd(start)
- nextBatch = await getNextBatch(
- collection,
- query,
- start,
- end,
- projection,
- findOptions
- )
- if (nextBatch.length > 0) {
- end = nextBatch[nextBatch.length - 1]._id
- updated += nextBatch.length
+ while (start !== BATCH_RANGE_END) {
+ let end = getNextEnd(start)
+ nextBatch = await getNextBatch(
+ collection,
+ query,
+ start,
+ end,
+ projection,
+ findOptions
+ )
+ if (nextBatch.length > 0) {
+ end = nextBatch[nextBatch.length - 1]._id
+ updated += nextBatch.length
- if (VERBOSE_LOGGING) {
- console.log(
- `Running update on batch with ids ${JSON.stringify(
- nextBatch.map(entry => entry._id)
- )}`
- )
- }
- await trackProgress(
- `Running update on batch ending ${renderObjectId(end)}`
+ if (VERBOSE_LOGGING) {
+ console.log(
+ `Running update on batch with ids ${JSON.stringify(
+ nextBatch.map(entry => entry._id)
+ )}`
)
-
- if (typeof update === 'function') {
- await update(nextBatch)
- } else {
- await performUpdate(collection, nextBatch, update)
- }
+ } else {
+ console.error(`Running update on batch ending ${renderObjectId(end)}`)
+ }
+
+ if (typeof update === 'function') {
+ await update(nextBatch)
+ } else {
+ await performUpdate(collection, nextBatch, update)
}
- await trackProgress(`Completed batch ending ${renderObjectId(end)}`)
- start = end
}
- return updated
- } finally {
- BATCHED_UPDATE_RUNNING = false
+ console.error(`Completed batch ending ${renderObjectId(end)}`)
+ start = end
}
+ return updated
}
/**
diff --git a/libraries/mongo-utils/buildscript.txt b/libraries/mongo-utils/buildscript.txt
index ff07040970..ee90b005fb 100644
--- a/libraries/mongo-utils/buildscript.txt
+++ b/libraries/mongo-utils/buildscript.txt
@@ -1,10 +1,10 @@
mongo-utils
--dependencies=None
---docker-repos=us-east1-docker.pkg.dev/overleaf-ops/ol-docker
+--docker-repos=gcr.io/overleaf-ops
--env-add=
--env-pass-through=
--esmock-loader=False
--is-library=True
---node-version=22.17.0
+--node-version=20.18.2
--public-repo=False
---script-version=4.7.0
+--script-version=4.5.0
diff --git a/libraries/o-error/.dockerignore b/libraries/o-error/.dockerignore
new file mode 100644
index 0000000000..c2658d7d1b
--- /dev/null
+++ b/libraries/o-error/.dockerignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/libraries/o-error/.gitignore b/libraries/o-error/.gitignore
new file mode 100644
index 0000000000..cf2f0ad3fb
--- /dev/null
+++ b/libraries/o-error/.gitignore
@@ -0,0 +1,5 @@
+.nyc_output
+coverage
+node_modules/
+
+.npmrc
diff --git a/libraries/o-error/.nvmrc b/libraries/o-error/.nvmrc
index fc37597bcc..0254b1e633 100644
--- a/libraries/o-error/.nvmrc
+++ b/libraries/o-error/.nvmrc
@@ -1 +1 @@
-22.17.0
+20.18.2
diff --git a/libraries/o-error/buildscript.txt b/libraries/o-error/buildscript.txt
index 6a9334411a..b50683a5d6 100644
--- a/libraries/o-error/buildscript.txt
+++ b/libraries/o-error/buildscript.txt
@@ -1,10 +1,10 @@
o-error
--dependencies=None
---docker-repos=us-east1-docker.pkg.dev/overleaf-ops/ol-docker
+--docker-repos=gcr.io/overleaf-ops
--env-add=
--env-pass-through=
--esmock-loader=False
--is-library=True
---node-version=22.17.0
+--node-version=20.18.2
--public-repo=False
---script-version=4.7.0
+--script-version=4.5.0
diff --git a/libraries/o-error/index.cjs b/libraries/o-error/index.cjs
index 0bb7da653a..ef08b45f16 100644
--- a/libraries/o-error/index.cjs
+++ b/libraries/o-error/index.cjs
@@ -1,34 +1,20 @@
-// @ts-check
-
/**
* Light-weight helpers for handling JavaScript Errors in node.js and the
* browser.
*/
class OError extends Error {
- /**
- * The error that is the underlying cause of this error
- *
- * @type {unknown}
- */
- cause
-
- /**
- * List of errors encountered as the callback chain is unwound
- *
- * @type {TaggedError[] | undefined}
- */
- _oErrorTags
-
/**
* @param {string} message as for built-in Error
* @param {Object} [info] extra data to attach to the error
- * @param {unknown} [cause] the internal error that caused this error
+ * @param {Error} [cause] the internal error that caused this error
*/
constructor(message, info, cause) {
super(message)
this.name = this.constructor.name
if (info) this.info = info
if (cause) this.cause = cause
+ /** @private @type {Array | undefined} */
+ this._oErrorTags // eslint-disable-line
}
/**
@@ -45,7 +31,7 @@ class OError extends Error {
/**
* Wrap the given error, which caused this error.
*
- * @param {unknown} cause the internal error that caused this error
+ * @param {Error} cause the internal error that caused this error
* @return {this}
*/
withCause(cause) {
@@ -79,16 +65,13 @@ class OError extends Error {
* }
* }
*
- * @template {unknown} E
- * @param {E} error the error to tag
+ * @param {Error} error the error to tag
* @param {string} [message] message with which to tag `error`
* @param {Object} [info] extra data with wich to tag `error`
- * @return {E} the modified `error` argument
+ * @return {Error} the modified `error` argument
*/
static tag(error, message, info) {
- const oError = /** @type {{ _oErrorTags: TaggedError[] | undefined }} */ (
- error
- )
+ const oError = /** @type{OError} */ (error)
if (!oError._oErrorTags) oError._oErrorTags = []
@@ -119,7 +102,7 @@ class OError extends Error {
*
* If an info property is repeated, the last one wins.
*
- * @param {unknown} error any error (may or may not be an `OError`)
+ * @param {Error | null | undefined} error any error (may or may not be an `OError`)
* @return {Object}
*/
static getFullInfo(error) {
@@ -146,7 +129,7 @@ class OError extends Error {
* Return the `stack` property from `error`, including the `stack`s for any
* tagged errors added with `OError.tag` and for any `cause`s.
*
- * @param {unknown} error any error (may or may not be an `OError`)
+ * @param {Error | null | undefined} error any error (may or may not be an `OError`)
* @return {string}
*/
static getFullStack(error) {
@@ -160,7 +143,7 @@ class OError extends Error {
stack += `\n${oError._oErrorTags.map(tag => tag.stack).join('\n')}`
}
- const causeStack = OError.getFullStack(oError.cause)
+ const causeStack = oError.cause && OError.getFullStack(oError.cause)
if (causeStack) {
stack += '\ncaused by:\n' + indent(causeStack)
}
diff --git a/libraries/o-error/test/o-error-util.test.js b/libraries/o-error/test/o-error-util.test.js
index b29dd4900a..c86cec44a2 100644
--- a/libraries/o-error/test/o-error-util.test.js
+++ b/libraries/o-error/test/o-error-util.test.js
@@ -268,11 +268,6 @@ describe('utils', function () {
expect(OError.getFullInfo(null)).to.deep.equal({})
})
- it('works when given a string', function () {
- const err = 'not an error instance'
- expect(OError.getFullInfo(err)).to.deep.equal({})
- })
-
it('works on a normal error', function () {
const err = new Error('foo')
expect(OError.getFullInfo(err)).to.deep.equal({})
diff --git a/libraries/o-error/test/o-error.test.js b/libraries/o-error/test/o-error.test.js
index db87f56992..84244ec92e 100644
--- a/libraries/o-error/test/o-error.test.js
+++ b/libraries/o-error/test/o-error.test.js
@@ -35,14 +35,6 @@ describe('OError', function () {
expect(err2.cause.message).to.equal('cause 2')
})
- it('accepts non-Error causes', function () {
- const err1 = new OError('foo', {}, 'not-an-error')
- expect(err1.cause).to.equal('not-an-error')
-
- const err2 = new OError('foo').withCause('not-an-error')
- expect(err2.cause).to.equal('not-an-error')
- })
-
it('handles a custom error type with a cause', function () {
function doSomethingBadInternally() {
throw new Error('internal error')
diff --git a/libraries/object-persistor/.dockerignore b/libraries/object-persistor/.dockerignore
new file mode 100644
index 0000000000..c2658d7d1b
--- /dev/null
+++ b/libraries/object-persistor/.dockerignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/libraries/object-persistor/.gitignore b/libraries/object-persistor/.gitignore
new file mode 100644
index 0000000000..6a20893208
--- /dev/null
+++ b/libraries/object-persistor/.gitignore
@@ -0,0 +1,4 @@
+/node_modules
+*.swp
+
+.npmrc
diff --git a/libraries/object-persistor/.nvmrc b/libraries/object-persistor/.nvmrc
index fc37597bcc..0254b1e633 100644
--- a/libraries/object-persistor/.nvmrc
+++ b/libraries/object-persistor/.nvmrc
@@ -1 +1 @@
-22.17.0
+20.18.2
diff --git a/libraries/object-persistor/buildscript.txt b/libraries/object-persistor/buildscript.txt
index 897e789700..c74883c30d 100644
--- a/libraries/object-persistor/buildscript.txt
+++ b/libraries/object-persistor/buildscript.txt
@@ -1,10 +1,10 @@
object-persistor
--dependencies=None
---docker-repos=us-east1-docker.pkg.dev/overleaf-ops/ol-docker
+--docker-repos=gcr.io/overleaf-ops
--env-add=
--env-pass-through=
--esmock-loader=False
--is-library=True
---node-version=22.17.0
+--node-version=20.18.2
--public-repo=False
---script-version=4.7.0
+--script-version=4.5.0
diff --git a/libraries/object-persistor/src/FSPersistor.js b/libraries/object-persistor/src/FSPersistor.js
index 38a81407df..01aab72800 100644
--- a/libraries/object-persistor/src/FSPersistor.js
+++ b/libraries/object-persistor/src/FSPersistor.js
@@ -305,10 +305,8 @@ module.exports = class FSPersistor extends AbstractPersistor {
async _listDirectory(path) {
if (this.useSubdirectories) {
- // eslint-disable-next-line @typescript-eslint/return-await
return await glob(Path.join(path, '**'))
} else {
- // eslint-disable-next-line @typescript-eslint/return-await
return await glob(`${path}_*`)
}
}
diff --git a/libraries/object-persistor/src/PerProjectEncryptedS3Persistor.js b/libraries/object-persistor/src/PerProjectEncryptedS3Persistor.js
index a0230128fe..7bd4bb93e5 100644
--- a/libraries/object-persistor/src/PerProjectEncryptedS3Persistor.js
+++ b/libraries/object-persistor/src/PerProjectEncryptedS3Persistor.js
@@ -33,10 +33,6 @@ const AES256_KEY_LENGTH = 32
* @property {() => Promise>} getRootKeyEncryptionKeys
*/
-/**
- * @typedef {import('./types').ListDirectoryResult} ListDirectoryResult
- */
-
/**
* Helper function to make TS happy when accessing error properties
* AWSError is not an actual class, so we cannot use instanceof.
@@ -395,9 +391,9 @@ class PerProjectEncryptedS3Persistor extends S3Persistor {
* A general "cache" for project keys is another alternative. For now, use a helper class.
*/
class CachedPerProjectEncryptedS3Persistor {
- /** @type SSECOptions */
+ /** @type SSECOptions */
#projectKeyOptions
- /** @type PerProjectEncryptedS3Persistor */
+ /** @type PerProjectEncryptedS3Persistor */
#parent
/**
@@ -428,16 +424,6 @@ class CachedPerProjectEncryptedS3Persistor {
return await this.#parent.getObjectSize(bucketName, path)
}
- /**
- *
- * @param {string} bucketName
- * @param {string} path
- * @return {Promise}
- */
- async listDirectory(bucketName, path) {
- return await this.#parent.listDirectory(bucketName, path)
- }
-
/**
* @param {string} bucketName
* @param {string} path
diff --git a/libraries/object-persistor/src/S3Persistor.js b/libraries/object-persistor/src/S3Persistor.js
index 1849838ba4..2835a271ff 100644
--- a/libraries/object-persistor/src/S3Persistor.js
+++ b/libraries/object-persistor/src/S3Persistor.js
@@ -20,18 +20,6 @@ const { URL } = require('node:url')
const { WriteError, ReadError, NotFoundError } = require('./Errors')
const zlib = require('node:zlib')
-/**
- * @typedef {import('aws-sdk/clients/s3').ListObjectsV2Output} ListObjectsV2Output
- */
-
-/**
- * @typedef {import('aws-sdk/clients/s3').Object} S3Object
- */
-
-/**
- * @typedef {import('./types').ListDirectoryResult} ListDirectoryResult
- */
-
/**
* Wrapper with private fields to avoid revealing them on console, JSON.stringify or similar.
*/
@@ -278,12 +266,26 @@ class S3Persistor extends AbstractPersistor {
* @return {Promise}
*/
async deleteDirectory(bucketName, key, continuationToken) {
- const { contents, response } = await this.listDirectory(
- bucketName,
- key,
- continuationToken
- )
- const objects = contents.map(item => ({ Key: item.Key || '' }))
+ let response
+ const options = { Bucket: bucketName, Prefix: key }
+ if (continuationToken) {
+ options.ContinuationToken = continuationToken
+ }
+
+ try {
+ response = await this._getClientForBucket(bucketName)
+ .listObjectsV2(options)
+ .promise()
+ } catch (err) {
+ throw PersistorHelper.wrapError(
+ err,
+ 'failed to list objects in S3',
+ { bucketName, key },
+ ReadError
+ )
+ }
+
+ const objects = response.Contents?.map(item => ({ Key: item.Key || '' }))
if (objects?.length) {
try {
await this._getClientForBucket(bucketName)
@@ -314,36 +316,6 @@ class S3Persistor extends AbstractPersistor {
}
}
- /**
- *
- * @param {string} bucketName
- * @param {string} key
- * @param {string} [continuationToken]
- * @return {Promise}
- */
- async listDirectory(bucketName, key, continuationToken) {
- let response
- const options = { Bucket: bucketName, Prefix: key }
- if (continuationToken) {
- options.ContinuationToken = continuationToken
- }
-
- try {
- response = await this._getClientForBucket(bucketName)
- .listObjectsV2(options)
- .promise()
- } catch (err) {
- throw PersistorHelper.wrapError(
- err,
- 'failed to list objects in S3',
- { bucketName, key },
- ReadError
- )
- }
-
- return { contents: response.Contents ?? [], response }
- }
-
/**
* @param {string} bucketName
* @param {string} key
diff --git a/libraries/object-persistor/src/types.d.ts b/libraries/object-persistor/src/types.d.ts
deleted file mode 100644
index 5640685a5f..0000000000
--- a/libraries/object-persistor/src/types.d.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-import type { ListObjectsV2Output, Object } from 'aws-sdk/clients/s3'
-
-export type ListDirectoryResult = {
- contents: Array