1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 15:28:06 +02:00
overleaf-toolkit/doc
Miguel Serrano e2b99f150f
Scripts to update config/overleaf.rc and config-seed rebrand (#217)
* Add scripts to rebrand variables.env and overleaf.rc

* Update bin/upgrade to prompt for config file rebrand

* Update bin/up to check for correct variable prefix

Ensures SHARELATEX_ is in place for version <= 4.x, and
OVERLEAF_ for version >= 5.x

* Rebrand variables for bin/docker-compose

Updates docker-compose.base.yml and sibling containers
base file with the changes in the script

* Update bin/doctor to support OVERLEAF_ prefix

* Update documentation with the OVERLEAF_ prefix

* Rebrand variables.env and overleaf.rc in config-seed

* Prepare config/version and CHANGELOG for release (WIP)

* Fix script documentation

Co-authored-by: Jakob Ackermann <jakob.ackermann@overleaf.com>

* Fix doctor logs

Co-authored-by: Jakob Ackermann <jakob.ackermann@overleaf.com>

* Remove unnecessary fallbacks to SHARELATEX_ vars

* SEt OVERLEAF_DATA_PATH to data/overleaf

* Remove duplicated environment entries

* Moved prefix brand checs from bin/up to bin/docker-compose

* Move set +o pipefail into subshell commands

* Use separate legacy compose files for required SHARELATEX_ vars

* Handle overleaf.rc rebranding before version upgrade

* Group output from rebranding process

* Move prompt for rebranding into helper function

* Refuse to start with mismatching ShareLaTeX vs Overleaf branded configs

* Print expected prefix when checking variables.env

* Print number of mismatching variables in overleaf.rc

* Check on variable rebranding from bin/doctor

* Cleanup bin/doctor lookup for ShareLaTeX branded overleaf.rc

* Update filesystem paths in bin/logs and docs

* Flag old TEXMFVAR entry in config/variables.env

REF: 1829e7ee2a

* Update config-seed version to 5.0.1 and changelog

---------

Co-authored-by: Jakob Ackermann <jakob.ackermann@overleaf.com>
2024-04-02 16:43:08 +02:00
..
img Public release of the Overleaf Toolkit 2020-08-19 13:31:17 +01:00
ce-upgrading-texlive.md Instructions for maintaining older TeX Live versions 2021-08-27 12:05:36 -04:00
configuration.md Use Docker Compose v2 2023-05-16 16:45:59 -04:00
dependencies.md Use Docker Compose v2 2023-05-16 16:45:59 -04:00
docker-compose.md Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
getting-server-pro.md Public release of the Overleaf Toolkit 2020-08-19 13:31:17 +01:00
ldap.md Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
overleaf-rc.md Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
overview.md Docs: Fix link to doc/ directory on GitHub 2024-02-09 12:29:01 +00:00
persistent-data.md Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
quick-start-guide.md Documentation fixes 2023-05-17 14:16:55 -04:00
README.md Add a TLS proxy option to the Toolkit 2021-04-08 12:02:15 +01:00
saml.md Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
sandboxed-compiles.md Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
the-doctor.md Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
tls-proxy.md Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
upgrading-from-0.x.md [docs] extend docs for upgrading from 0.x 2022-11-17 13:03:29 +00:00
upgrading.md Public release of the Overleaf Toolkit 2020-08-19 13:31:17 +01:00

Documentation

Welcome to the documentation for the Overleaf Toolkit.

This documentation is under construction. You can still find the legacy documentation on the Overleaf Wiki

Getting Started

Using the Toolkit

Configuration

Persistent Data

Server Pro

Upgrades