Release Notes 4.x.x

Server Pro 4.1.2

Release date: 2023-09-27

• Server Pro Image ID: fab9def8230a
• Community Edition Image ID: 1ce6ef6ea798
• Git Bridge Image ID: dcdacb194599

This release includes security updates for the Git Bridge.

Server Pro 4.1.1

Release date: 2023-09-05

• Server Pro Image ID: fab9def8230a
• Community Edition Image ID: 1ce6ef6ea798
• Git Bridge Image ID: e5e9753fc979

Bugfixes

• Hide tabs on user admin info pages that are only relevant for overleaf.com

Server Pro 4.1.0

Release date: 2023-08-24

• Server Pro Image ID: a6c6bfe92bd1
• Community Edition Image ID: 1ce6ef6ea798
• Git Bridge Image ID: e5e9753fc979

Security release

Server Pro 4.1 is a security release for the application runtime.

The Node.js runtime has been upgraded from version 16 to 18 ahead of the upcoming deprecation of Node.js 16 on September 11, 2023.

Only Server Pro 4.1 will operate with Node.js 18. All other supported versions of Server Pro require Node.js 16, which is being deprecated. We recommend that all customers upgrade to Server Pro 4.1 at their earliest convenience.

If an access point to your Server Pro instance is publicly accessible via the internet, such as a login page or redirect to it, it is particularly important that you upgrade to Server Pro version 4.1 before September 11, 2023.

History migration

Reminder: History migration for Server Pro 3.5.X and earlier

If you are still using a Server Pro version before 4.0, we recommend starting with the upgrade process immediately. In Server Pro 4.0 we introduced a breaking change in the history system that requires migrating all the history data into the new system in order for Server Pro to function.

The migration process can handle the majority of project histories without any manual work. However, very old projects can contain data that require additional steps to migrate. Starting the migration process now will give our support team adequate time to take a look into your migration issues and help you finish the migration ahead of the EOL date.

History cleanup

Cleanup of orphaned data

Server Pro versions 3.5.11, 4.0.6 and the latest 4.1 release include an updated script that fully deletes orphaned mongo data from the old history system. It is safe to run the script again. Please refer to the documentation on how to run the cleanup script.

Upcoming changes

Retirement of legacy source editor

Server Pro 4.1 will be the last release with the legacy source editor. You can read more about the new editing experience on our blog.

Other changes

Rich Text/Visual Editor enhancements

• The Rich Text/Visual editing experience has been improved.
• The "Source" editor has been renamed to "Code Editor" and the "Rich Text" editor has been renamed to "Visual Editor".

Server Pro 4.0.6

Release date: 2023-08-10

Image ID: da6f6f617532 (Community Edition Image ID: 504b19c82c27)

• Bring back the History Migration Cleanup Script with a fix to free up mongo storage space.

  ⚠️ We advise customers to re-run the script again as per the documentation.

Server Pro 4.0.5

Release date: 2023-07-20

• Server Pro Image ID: bd37a572f01a
• Community Edition Image ID: 883bb853c896
• Git Bridge Image ID: 9bfd98050a43

Bugfixes

• Fixes numbers replaced by underscores when downloading projects (overleaf/overleaf/issues/1133).

Other changes

• Security updates.

Server Pro 4.0.4

Release date: 2023-07-14

• Server Pro Image ID: bcec664460d0
• Community Edition Image ID: 1cf00822f942
• Git Bridge Image ID: 9bfd98050a43

This release includes security updates.

Server Pro 4.0.3

Release date: 2023-06-29

• Server Pro Image ID: 963eb95c3c86
• Community Edition Image ID: 380e3cb72a42
• Git Bridge Image ID: 9bfd98050a43

Fixes a bug preventing anonymous users from adding changes to the Project History.

Server Pro 4.0.2

Release date: 2023-06-08

• Server Pro Image ID: aa27991a39a7
• Community Edition Image ID: 26c75dfb6485
• Git Bridge Image ID: 9bfd98050a43

Fixes a bug navigating through the documentation pages when SHARELATEX_PROXY_LEARN=true.

Server Pro 4.0.1

Release date: 2023-05-30

• Server Pro Image ID: 3014d696b579
• Community Edition Image ID: 26c75dfb6485
• Git Bridge Image ID: 9bfd98050a43

Note: An issue was discovered with version 4.0 so it was never made public. This resulted in 4.0.1 being the first release in the 4.0 release line.

Important: Before upgrading to this new major version you will need to first upgrade your Overleaf Server Pro instance to version 3.5.10 and migrate your projects to the new Full Project History system. Server Pro 4.0.0 will fail to start unless all the projects have been migrated.

Read Full Project History migration instructions.

This major release includes database migrations. Please ensure you have a database backup before upgrading.

MongoDB now needs to run as a Replica Set. If you use an external Mongo database, you might already be running a replica set. If you use the Overleaf Toolkit you just need to pull the Toolkit's latest version. If you don't use the Toolkit, please see the instructions at the end of these release notes.

We’ve also updated the version of Redis to 6.2. This change requires no action other than updating the image version. If you’re using the Overleaf Toolkit, add the environment variable REDIS_IMAGE=redis:6.2 to config/overleaf.rc (or update the version, if it was already defined). If you’re using a custom docker-compose.yml, change the redis container image to redis:6.2.

New Features (Server Pro only)

• Overleaf Git integration – See the documentation for instructions to set up the git-bridge in your Server Pro install.
• Enhanced Rich Text functionality – Rich-text commenting and tracked changes.
• Support documentation for horizontal scaling, which allows for increased computing resources for large deployments

New Features for Overleaf Community Edition and Server Pro

• A new Source editor in addition to the Legacy editor will be available to users. (The Legacy editor will eventually be retired. If users have any feedback or issues, please fill out this form.) The new Source editor provides better accessibility, and better support for non-latin text.

• Deleted projects and users can be automatically cleaned up after 90 days. This is an opt-in feature that can be enabled by setting the ENABLE_CRON_RESOURCE_DELETION environment variable to true. See the configuration documentation.

Other changes

• TeXLive 2023 is now the default version for instances not running Sandboxed Compiles.
• The limit on a project’s editable content size (the sum of sizes of all editable files) has been increased from 5MB to 7MB.
• General performance and stability improvements to the application, along with many small improvements and bug fixes.

Manually setting up MongoDB as a replica set

The following instructions are not necessary if you use the Overleaf Toolkit or if you use an external Mongo database already configured as a replica set.

If you run MongoDB with docker-compose, add the following command to the mongo container configuration:

mongo:
    command: "--replSet overleaf"

Restart the mongo container then start a mongo shell with docker-compose exec -it mongo mongo. In that shell, run the following command to initiate the replica set:

rs.initiate({ _id: "overleaf", members: [ { _id: 0, host: "mongo:27017" } ] })