Home - yu-i-i/overleaf-cep GitHub Wiki

This is the home of Overleaf Extended Community Edition.

Setup

The Overleaf Toolkit is the recommended way to deploy and manage Overleaf Extended Community Edition. We encourage new Overleaf users to get started with the Toolkit Quick Start Guide.

The legacy instructions remain in place for existing docker-compose based deployments.

General information on setting up and managing Overleaf, as well as upstream release notes, can be found on the Overleaf Wiki Page.

Extended CE Release Notes

v6.1.2-ext-v4.1

  • Git Bridge: fixed wrong router for PAT validation endpoint
  • Git Bridge: use GIT_* environment variables to generate nginx configuration
  • Admin tools: introduced themed dashboard suppot
  • Introduced environment variable OVERLEAF_THEMED_DASHBOARD to enable experimental themed dashboards

v6.1.2-ext-v4.0

  • Based on upstream release v6.1.2
  • Introduced Git integration
  • Added environment variable OVERLEAF_HISTORY_RESTORE to enable restoring a project or file from a history snapshot, see Environment Variables
  • Administrator tools: significantly improved page rendering performance when handling large numbers of users or projects; added pagination to user and project lists
  • Template gallery: security fix — non-privileged user could manage a template not owned by that user
  • Template gallery: introduced template manager role (environment variable OVERLEAF_TEMPLATES_USER_ID)
  • Linked URL: security fix — prevents access to internal services via crafted links
  • Authentication: updated passport-ldapauth to 3.0.1
  • Sandboxed compiles: set imageName to default when undefined on the first project opening (for migration from CE)
  • Sandboxed compiles: - Sandboxed compiles: added scripts to add or remove the repository prefix in project imageName

v6.1.1-ext-v3.5

  • Based on upstream release v6.1.1
  • New design of the Overleaf editor (supports light and dark themes)
  • Introduced TEX_LIVE_DOCKER_IMAGE_ROOT environment variable to simplify changing TeX Live Docker images. For details, see Sandboxed Compiles
  • Introduced OVERLEAF_EMAIL_SMTP_PASS_FILE envirionment variable
  • Fixed several bugs in tools for administrators to manage users and projects
  • Fixed support for Sandboxed compiles on arm64 architecture

v6.0.1-ext-v3.4

  • Introduced advanced tools for administrators to manage users and projects

v6.0.1-ext-v3.3

  • Based on upstream release v6.0.1

v6.0.0-ext-v3.3

  • Security fix: external URLs are now normalized and sanitized

v6.0.0-ext-v3.2

  • Based on upstream release v6.0.0

⚠️ You must upgrade to v5.5.6-ext-vX.Y before attempting to upgrade to v6.0.0-ext-vX.Y. Please read the upstream documentation carefully and follow the instructions.

⚠️ New Extended CE versions based on upstream 5.X.Y will no longer be produced, except for security fixes for a limited period. If you want to keep receiving feature updates, upgrade to v6.0.0-ext-vX.Y.

v5.5.6-ext-v3.3

  • Security fix: external URLs are now normalized and sanitized. The image should be updated using 5.5.6-ext-3.3 hotfix.

v5.5.6-ext-v3.2

  • Based on upstream release v5.5.6
  • Fixed an issue where Sandboxed Compiles stopped working due to excessively strict seccomp restrictions
  • Introduced the MAX_UPLOAD_SIZE variable to control the maximum allowed size for uploaded projects and files
  • Security fix: Files attached from an external URL are now fetched through a proxy. For details, see Security Note

v5.5.4-ext-v3.1

  • Based on upstream release v5.5.4

v5.5.2-ext-v3.1

  • Based on upstream release v5.5.2
  • Added OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS variable to restrict JIT account creation for users authenticating via OIDC, based on their email domains

v5.5.0-ext-v3

  • Based on upstream release v5.5.0

v5.4.1-ext-v3

  • Based on upstream release 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)

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