mirrors/toolkit
1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-12-05 01:10:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
toolkit/CHANGELOG.md
Miguel Serrano 512ef93b7f Update config-seed to 6.0.1
2025-11-17 12:50:23 +01:00

19 KiB
Raw Permalink Blame History

Changelog

2025-11-17

Added

  • Updated default version to 6.0.1.

2025-10-29

Added

  • Updated default version to 6.0.0.

    ⚠️ This is a major release. Please check the release notes for details.

  • Updated mongo default version to 8.0.

  • Updated redis default version to 7.4.

2025-10-29

Added

  • Updated default version to 5.5.6.

2025-10-23

Added

  • Updated default version to 5.5.5.

2025-08-14

Changed

  • Upgrade default nginx version for TLS proxy to version 1.28. If you configured a custom NGINX_IMAGE, please upgrade it.

  • Fix graceful shutdown procedure with TLS proxy enabled. Swap the dependency between the TLS proxy and Server Pro/CE container. This ensures that bin/stop will wait for the application container to stop before taking down the TLS proxy. Notably this ensures that connected users can flush their changes as part of the graceful shutdown procedure. Please align your nginx config with the updated default configuration (add upstream, configure docker as resolver and switch proxy_pass to upstream) by comparing config/nginx/nginx.conf and lib/config-seed/nginx.conf.

  • Automatically configure OVERLEAF_SECURE_COOKIE/OVERLEAF_BEHIND_PROXY/OVERLEAF_TRUSTED_PROXY_IPS for TLS proxy. In case you are using a subnet from 172.16.0.0/12 (default subnet for Docker networks) for your regular network, please set OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network> in your config/variables.env. Where <network> is the IPAM -> Config -> Subnet value in docker inspect overleaf_default, e.g. OVERLEAF_TRUSTED_PROXY_IPS=loopback,172.19.0.0/16

    Customers with an external TLS proxy (i.e. not managed by the Overleaf Toolkit), please ensure that OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy> is set in your config/variables.env, e.g. OVERLEAF_TRUSTED_PROXY_IPS=loopback,192.168.13.37.

2025-08-04

Added

  • Updated default version to 5.5.4.

Fixed

  • Fix Permission denied errors when running bin/upgrade.

2025-07-29

Added

  • Updated default version to 5.5.3.

2025-07-09

Added

  • Updated default version to 5.5.2.

2025-05-28

Added

  • Updated default version to 5.5.1.

2025-05-28

Added

  • Updated default version to 5.5.0.

2025-04-30

Added

  • Updated default version to 5.4.1.

2025-04-11

Added

  • Updated default version to 5.4.0.

2025-03-21

Added

  • Updated default version to 5.3.3.

2025-03-11

Added

  • Updated default version to 5.3.2.

2025-01-29

Added

  • Updated default version to 5.3.1.

2025-01-06

Added

  • Add new config option for skipping docker pull before upgrading
  • Document config options for air-gapped setups

2024-11-18

Added

  • 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

2024-10-29

Added

  • Pull new images from bin/upgrade ahead of stopping containers

2024-10-24

Added

Changed

  • If set, the overleaf.rc entry GIT_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

2024-09-24

Added

  • Print warning when running bin/up without detach mode

2024-09-11

Added

  • 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

2024-09-03

Added

  • Add a new config option OVERLEAF_LOG_PATH for making application logs available on the Docker host.

2024-08-27

Added

  • Surface MONGO_VERSION from bin/doctor

2024-08-20

Fixed

  • Fix unquoting of variables (e.g. ALL_TEX_LIVE_DOCKER_IMAGES)

2024-08-13

Added

  • Updated default version to 5.1.1.

2024-07-30

Added

  • New bin/run-script command

2024-07-29

Fixed

  • Sandboxed Compiles is available for Server Pro only

2024-07-17

Added

2024-07-16

Added

  • Added support for Mongo 6.0.

2024-07-12

Added

  • Updated default version to 5.0.7. ⚠️ 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.

2024-06-21

Added

  • 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

2024-06-20

Added

  • Updated default version to 5.0.6. ⚠️ 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.

2024-06-11

Added

  • Updated default version to 5.0.5. ⚠️ 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.

2024-05-27

Added

  • Pull TeX Live images from bin/up

    You can disable the automatic pulling using SIBLING_CONTAINERS_PULL=false in your config/overleaf.rc file.

2024-05-24

Added

  • Updated default version to 5.0.4. ⚠️ This is a security release. Please check the release notes for details.

2024-05-08

Added

  • Add warning for using docker installing via snap.

2024-04-22

Added

  • Updated default version to 5.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.

2024-04-22

Added

  • Updated default version to 5.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.

Fixed

  • Retracted release 5.0.2

    ⚠️ We have identified a few corner cases in the recovery procedure for docs.

2024-04-18

Fixed

  • 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.

2024-04-09

Added

  • Print column headers from bin/images
  • List Git Bridge images via bin/images

2024-04-02

Added

  • Updated default version to 5.0.1.

    ⚠️ This is a major release. Please check the release notes for details.

  • Rebranded 'SHARELATEX_' variables to 'OVERLEAF_'

2024-02-27

Fixed

  • 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 running bin/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.

2024-02-16

Added

  • Updated default version to 4.2.3.

    ⚠️ This is a security release. Please check the release notes for details.

2024-02-14

Added

  • Updated default version to 4.2.2.

    ⚠️ This is a security release. Please check the release notes for details.

2024-01-12

Added

  • Updated Mongo version from 4.4 to 5.0 in config seed. Documentation on Mongo updates can be found here.

2023-11-10

Added

  • Updated default version to 4.2.0.

2023-11-02

Added

  • Updated default version to 4.1.6. The previous release 4.1.5 is an important bug fix release for the history system, see the full release notes.

2023-10-24

Added

  • bin/logs: Pick up logs from history-v1 and project-history
  • Updated default version to 4.1.4.

2023-10-06

Added

  • Updated default version to 4.1.3.

2023-09-18

Added

  • Prepare for addition of web-api service in upcoming Server Pro 4.2 release.

2023-09-06

Added

2023-08-24

Added

  • Updated default version to 4.1.0.

    ⚠️ This is a security release. Please check the release notes for details.

2023-08-11

Added

2023-07-28

Added

  • 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.

2023-07-20

Added

  • Updated default version to 4.0.5.

2023-07-14

Added

  • Updated default version to 4.0.4.

2023-06-29

Added

  • Updated default version to 4.0.3.

2023-06-08

Added

  • Updated default version to 4.0.2.

2023-05-30

Added

  • Updated default version to 4.0.1.

2023-05-16

Added

  • Use Docker Compose v2 by default. Fall back to Docker Compose v1 if v2 is unavailable.

Fixed

  • Propagate the REDIS_PORT variable to the sharelatex container

2023-05-15

Added

  • Support listing container logs with bin/logs command
  • bin/logs -n all shows all logs for a given service

2023-05-11

Added

  • Change the location of the git-bridge data directory to /data/git-bridge inside the container

2023-05-01

Added

  • Start Mongo in a replica set by default

2023-04-14

Fixed

  • Fix openssl invocation on OS X

2023-04-13

Fixed

  • Ensure git bridge is disabled by default

2023-04-10

Added

  • Git bridge support in Server Pro 4.x

2023-03-21

Added

  • Updated default version to 3.5.5.

2023-03-20

Added

  • Updated default version to 3.5.4.

2023-03-16

Added

  • Updated default version to 3.5.3.

2023-03-07

Added

  • Updated default version to 3.5.2.

2023-03-06

Added

  • Updated default version to 3.5.1.

2023-02-28

Added

  • Add variables for S3
  • Extend doctor script to flag incomplete S3 config

2023-02-10

Added

  • Increase SIGKILL timeout for docker container to enable graceful shutdown in version 3.5 onwards

2023-01-11

Added

  • Updated default version to 3.4.0.

2022-11-15

Added

  • Updated default version to 3.3.2.

2022-10-13

Added

  • Updated default version to 3.3.0.

2022-09-22

Added

  • Updated default version to 3.2.2.

2022-08-16

Added

  • Updated default version to 3.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.

2021-10-13

Added

  • HTTP to HTTPS redirection.
    • Listen mode of the sharelatex container now localhost only, so the value of SHARELATEX_LISTEN_IP must be set to the public IP address for direct container access.

2021-08-12

Added

  • Server Pro: New variable to control LDAP and SAML, EXTERNAL_AUTH, which can be set to one of ldap, 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.
    • This should not affect current installations. Please contact support if you encounter any problems
    • See LDAP and SAML documentation for more

2020-11-25

Added

  • bin/upgrade displays any changes to the changelog and prompts for confirmation before applying the remote changes to the local branch.

Misc

  • Fix code linting errors in bin/ scripts

2020-11-19

Added

  • Updated default version to 2.5.0
  • Updated Mongo version from 3.6 to 4.0. Documentation on Mongo updates can be found here.

2020-10-22

Added

2020-10-21

Added

  • bin/up now passes along any supplied flags to docker-compose, for example: bin/up -d will run in detached mode
  • Documentation on how to update environment variables. (documentation)

Fixed

  • A typo

2020-10-09

Added

  • Add SHARELATEX_PORT option to overleaf.rc file, which defaults to 80, same as the previous hard-coded value. (documentation)
Reference in New Issue View Git Blame Copy Permalink