- When a custom
GIT_BRIDGE_IMAGE
is set,bin/upgrade
no longer tries to pull the new version, and prompts the user to update and tag the custom image separately. - Tighten SSL security on nginx proxy
- Pull new images from
bin/upgrade
ahead of stopping containers
- Updated default
version
to5.2.1
. - Drop support for Docker Compose v1. How to switch to Compose V2. Docker Compose v1 has reached its End Of Life in July 2023.
-
If set, the
overleaf.rc
entryGIT_BRIDGE_IMAGE
must be specified without the version now.Example:
-GIT_BRIDGE_IMAGE=my.registry.com/overleaf/git-bridge:5.1.1 +GIT_BRIDGE_IMAGE=my.registry.com/overleaf/git-bridge
- Print warning when running
bin/up
without detach mode
- Add loud warning to
bin/doctor
when not using Sandboxed Compiles/SIBLING_CONTAINERS_ENABLED=true
- Add loud warning for using Community Edition with
SIBLING_CONTAINERS_ENABLED=true
- Add a new config option
OVERLEAF_LOG_PATH
for making application logs available on the Docker host.
- Surface
MONGO_VERSION
frombin/doctor
- Fix unquoting of variables (e.g.
ALL_TEX_LIVE_DOCKER_IMAGES
)
- Updated default
version
to5.1.1
.
- New
bin/run-script
command
- Sandboxed Compiles is available for Server Pro only
-
Updated default
version
to5.1.0
. -
SIBLING_CONTAINERS_ENABLED
is now set totrue
for new installs inconfig-seed/overleaf.rc
.We strongly recommend enabling the Sandboxed Compiles feature for existing installations as well.
-
Added "--appendonly yes" configuration to redis.
Redis persistence documentation: https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/
-
Updated mongo to 6.0 in
config-seed/overleaf.rc
.Mongo image name needs to be split between
MONGO_IMAGE
(with just the image name) andMONGO_VERSION
inconfig/overleaf.rc
.
- Added support for Mongo 6.0.
-
Updated default
version
to5.0.7
. :warning: This is a security release. Please check the release notes for details.Note: Server Pro version 4.2.7 contains the equivalent security update for the 4.x.x release line.
-
Added warning for usage of legacy docker-compose v1.
docker-compose v1 has reached its End Of Life in July 2023 (https://docs.docker.com/compose/migrate/). Support for docker-compose v1 in the Overleaf Toolkit will be dropped with the release of Server Pro 5.2. We recommend upgrading to Docker Compose v2 before then.
-
Added warning for usage of End Of Life Docker versions before v23
-
Updated default
version
to5.0.6
. :warning: This is a security release. Please check the release notes for details.Note: Server Pro version 4.2.6 contains the equivalent security update for the 4.x.x release line.
-
Updated default
version
to5.0.5
. :warning: This is a security release. Please check the release notes for details.Note: Server Pro version 4.2.5 contains the equivalent security update for the 4.x.x release line.
-
Pull TeX Live images from
bin/up
You can disable the automatic pulling using
SIBLING_CONTAINERS_PULL=false
in yourconfig/overleaf.rc
file.
- Updated default
version
to5.0.4
. :warning: This is a security release. Please check the release notes for details.
- Add warning for using docker installing via
snap
.
-
Updated default
version
to5.0.3
.⚠️ This is a security release. This release also fixes a critical bug in a database migration as included in release 5.0.1. The recovery procedure for doc versions has been updated compared to 5.0.2. Please check the release notes for details.Note: Server Pro version 4.2.4 contains the equivalent security update for the 4.x.x release line.
-
Updated default
version
to5.0.2
.⚠️ This is a security release. This release also fixes a critical bug in a database migration as included in release 5.0.1. Please check the release notes for details.Note: Server Pro version 4.2.4 contains the equivalent security update for the 4.x.x release line.
-
Retracted release 5.0.2
⚠️ We have identified a few corner cases in the recovery procedure for docs.
-
Retracted release 5.0.1
⚠️ We have identified a critical bug in a database migration that causes data loss. Please defer upgrading to release 5.0.1 until further notice on the mailing list. Please hold on to any backups that were taken prior to upgrading to version 5.0.1.
- Print column headers from
bin/images
- List Git Bridge images via
bin/images
-
Updated default
version
to5.0.1
.⚠️ This is a major release. Please check the release notes for details. -
Rebranded 'SHARELATEX_' variables to 'OVERLEAF_'
-
Relaunch
bin/upgrade
after updating Toolkit code.We are planning to expand the scope of the
bin/upgrade
script in a following release and these changes need to be applied while runningbin/upgrade
.With this release there is a one-time requirement that you choose "Yes" to "Perform code update?" and "No" to "Upgrade image?". After the Toolkit code has been updated, run
bin/upgrade
again and choose to upgrade the image.
-
Updated default
version
to4.2.3
.⚠️ This is a security release. Please check the release notes for details.
-
Updated default
version
to4.2.2
.⚠️ This is a security release. Please check the release notes for details.
- Updated Mongo version from 4.4 to 5.0 in config seed. Documentation on Mongo updates can be found here.
- Updated default
version
to4.2.0
.
- Updated default
version
to4.1.6
. The previous release4.1.5
is an important bug fix release for the history system, see the full release notes.
bin/logs
: Pick up logs from history-v1 and project-history- Updated default
version
to4.1.4
.
- Updated default
version
to4.1.3
.
- Prepare for addition of web-api service in upcoming Server Pro 4.2 release.
-
Updated default
version
to4.1.1
.This is a bug fix release, see the full release notes.
-
Updated default
version
to4.1.0
.⚠️ This is a security release. Please check the release notes for details.
-
Updated default
version
to4.0.6
.From the release notes:
-
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.
-
-
Added support for a version suffix of
-with-texlive-full
to be able to load a custom image with TeXLive full backed in.Server Pro customers: We strongly recommend using Sandboxed compiles instead of running a custom TeXLive full installation. Please reach out to us if you have any questions or need help with setting up Sandboxed compiles in Server Pro.
- Updated default
version
to4.0.5
.
- Updated default
version
to4.0.4
.
- Updated default
version
to4.0.3
.
- Updated default
version
to4.0.2
.
- Updated default
version
to4.0.1
.
- Use Docker Compose v2 by default. Fall back to Docker Compose v1 if v2 is unavailable.
- Propagate the
REDIS_PORT
variable to the sharelatex container
- Support listing container logs with
bin/logs
command bin/logs -n all
shows all logs for a given service
- Change the location of the git-bridge data directory to /data/git-bridge inside the container
- Start Mongo in a replica set by default
- Fix openssl invocation on OS X
- Ensure git bridge is disabled by default
- Git bridge support in Server Pro 4.x
- Updated default
version
to3.5.5
.
- Updated default
version
to3.5.4
.
- Updated default
version
to3.5.3
.
- Updated default
version
to3.5.2
.
- Updated default
version
to3.5.1
.
- Add variables for S3
- Extend doctor script to flag incomplete S3 config
- Increase SIGKILL timeout for docker container to enable graceful shutdown in version 3.5 onwards
- Updated default
version
to3.4.0
.
- Updated default
version
to3.3.2
.
- Updated default
version
to3.3.0
.
- Updated default
version
to3.2.2
.
- Updated default
version
to3.2.0
. - Updated Mongo version from 4.2 to 4.4. Documentation on Mongo updates can be found here.
- Print warning when
SHARELATEX_LISTEN_IP
is not defined.
- HTTP to HTTPS redirection.
- Listen mode of the
sharelatex
container nowlocalhost
only, so the value ofSHARELATEX_LISTEN_IP
must be set to the public IP address for direct container access.
- Listen mode of the
- Server Pro: New variable to control LDAP and SAML,
EXTERNAL_AUTH
, which can be set to one ofldap
,saml
,none
. This is the preferred way to activate LDAP and SAML. For backward compatibility, if this is not set, we fall back to the legacy behaviour of inferring which module to activate from the relevant environment variables.
bin/upgrade
displays any changes to the changelog and prompts for confirmation before applying the remote changes to the local branch.
- Fix code linting errors in bin/ scripts
- Updated default
version
to 2.5.0 - Updated Mongo version from 3.6 to 4.0. Documentation on Mongo updates can be found here.
- Updated default
version
to 2.4.2
bin/up
now passes along any supplied flags todocker-compose
, for example:bin/up -d
will run in detached mode- Documentation on how to update environment variables. (documentation)
- A typo
- Add
SHARELATEX_PORT
option tooverleaf.rc
file, which defaults to80
, same as the previous hard-coded value. (documentation)