-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Release Notes 3.x.x
Release date: 2022-11-15
Image ID: c03e78f10d6d
(Community Edition Image ID: eab840a50369
)
This release includes a fix for a server error that can stop the project dashboard from opening:
TypeError: (project.archived || []).some is not a function
The fix sports a new migration for converting the archived
and trashed
state of projects from a per-project setting to a per-user setting.
Note: As always, please take a backup of your database before upgrading to this release.
Release date: 2022-10-18
Image Id: 9194fb1de6b3
(no Community Edition image)
This release includes a security update addressing potential vulnerabilities with SAML auth provider integration.
Release date: 2022-10-13
Image ID: 56f044d08198
(Community Edition Image ID: 4c4bad165ea6
)
This new release of Server Pro includes a MongoDB migration affecting several collections. Please ensure you have a database backup before upgrading.
For CE users, and Server Pro users that don't run Sandboxed Compiles there is a change in how Latex packages are installed, now requiring to run tlmgr path add
again after every use of tlmgr install
in order to correctly symlink all the binaries into the system path.
- Stop on First Error compilation mode
- User/Project audit logs can now store more than 200 entries.
- HTML content in Template descriptions is now sanitized using
sanitize-html
default options. This might affect your existing templates.
Release date: 2022-09-19
Image ID: 20e80bd600fb
(Community Edition Image ID: 8552c59519a7
)
- Fixes TexLive package setup (non-sandboxed compiles) (https://github.com/overleaf/overleaf/issues/1044)
Release date: 2022-08-26
Image ID: 3817bd0d07a4
(Community Edition Image ID: 31cc6bc2bfa7
)
- Fixes source editor not being displayed (https://github.com/overleaf/overleaf/issues/1043)
Release date: 2022-08-16
Image ID: 4db483917643
(Community Edition Image ID: 1bce84a47f1f
)
This new release of Server Pro includes several new features. It also requires updating Mongo version to 4.4
. Upgrade instructions are available here. Please ensure you have a database backup before upgrading.
- User Activity and License Usage information (with a count of active users) is now displayed in the Admin Panel.
- PDF Preview Detach.
- User Dictionary entries can now be deleted from the Editor Settings panel.
- TexLive 2022 is available for instances running Sandboxed Compiles. Check the documentation for instructions to upgrade. TexLive 2022 is also the default version for instances not running Sandboxed Compiles.
- Fixed history diff navigation.
Release date: 2022-08-10
Image ID: eb5802bfd8a4
(Community Edition Image ID: 401c5a25016d
)
- Fixes history diff navigation (https://github.com/overleaf/overleaf/issues/1035)
Release date: 2022-05-17
Image ID: 699e7c990b0f
(Community Edition Image ID: 9c9fe33828a0
)
This release requires updating Mongo version to 4.2
. Upgrade instructions are available here. Please ensure you have a database backup before upgrading.
- TexLive 2021 is available for instances running Sandboxed Compiles. Check the documentation for instructions to upgrade.
- The path of the application inside the container has changed from
/var/www/sharelatex
to/overleaf
; if you have bind mounts that use the old path, they will need to be updated. - Many small improvements and bugfixes.
Release date: 2021-10-05
Image ID: 5e87b3c5ad41
(Community Edition Image ID: 9155d8a13aaa
)
This major release includes migrations that update the database in a backwards incompatible format. Please ensure you have a database backup before upgrading, in case of roll-back you will not be able to read data in the new format.
This update brings general performance and stability improvements to the application, along with many small improvements and bugfixes.
We've recently updated the way we tag our docker images. In addition to 3.0.1
, we're also tagging the new version as 3
and 3.0
, representing the latest major and minor versions for the 3.x.x
branch respectively. These new tags will be updated again when a new minor or hotfix version is published.
latest
tag won't be immediately updated to this new major version. If you're using a docker-compose.yml
please update your image
tag to 3
, 3.0
or 3.0.1
. Toolkit users can continue using the bin/upgrade
script as usual.
Important: before upgrading to this new major version you need to upgrade to version 2.7.1
first.
A migration may occasionally fail due to unexpected duplicate entries in a mongo collection.
If upgrading from 2.7.1
to 3.0.1
fails with messages containing MongoError: Error during migrate "20190912145029_create_tags_indexes": E11000 duplicate key error collection: sharelatex.tags index: user_id_1_name_1 dup key: {<…>}
this means that one of your users has multiple tags/folders with the same name.
To recover, revert to your 2.7.1
backups and ask the user to make their tag/folder names unique. (The user id and specific tag name will be reported in the error message, so you can contact the affected user and mention the specific tag name that is problematic.) Then attempt the upgrade again.
You can also attempt to detect multiple tags in advance, before you upgrade, with the following aggregate:
docker exec -it mongo mongo
use sharelatex
db.tags.aggregate([
{$group: {
_id: {name: "$name", user_id: "$user_id"},
count: {$sum: 1}
}},
{$match: {count: {$gt: 1}}},
{$sort: {count: -1}}
])
If it returns no results, there are no duplicate tags, and the migration should succeed.
If you see the error MongoError: Error during migrate "20190912145001_create_contacts_indexes": E11000 duplicate key error collection: sharelatex.contacts index: user_id_1 dup key{<…>}
this indicates a similar problem in the contacts
collection. You can check how many entries are affected with the following command:
docker exec -it mongo mongo
use sharelatex
db.contacts.aggregate([
{$group: {
_id: {user_id: "$user_id"},
count: {$sum: 1}
}},
{$match: {count: {$gt: 1}}},
{$sort: {count: -1}}
])
The contacts collection is a cache of names which appear as completions in the "Share Project" modal, it is not critical data. You can remove individual duplicate entries with the command
db.contacts.deleteOne({ "user_id" : ObjectId("...") })
where the ObjectId value should be taken from the list of duplicates. When the duplicate contacts have been removed, the migration should succeed.
You might see a cert is required
error when upgrading from Server Pro 2.6.2
or earlier if SHARELATEX_SAML_CERT
is not provided.
If you come across the issue, please add the SHARELATEX_SAML_CERT
value, and update your instance to 2.7.1
before attempting to upgrade to 3.x.x
.
- Quickstart Guide (Overleaf Toolkit)
- Hardware Requirements
- Database & Dependencies
- Creating and managing users
- General configuration
- Configuring Email
- SSL & Nginx reverse proxy
- Data and Backups
- Configuring Headers, Footers & Logo
- Password Restrictions
- i18n Languages
- Logging
- Common Config Options
- F.A.Q
- Troubleshooting
- Full Project History Migration