mirrors/overleaf-toolkit
1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 07:18:06 +02:00
Code Activity
No description
267 commits 9 branches 0 tags 1.2 MiB
Find a file
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
.github added github Issue and PR templates for contributions 2020-10-02 12:32:22 +02:00
bin Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
config Public release of the Overleaf Toolkit 2020-08-19 13:31:17 +01:00
data Public release of the Overleaf Toolkit 2020-08-19 13:31:17 +01:00
doc Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
lib Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
.gitignore Public release of the Overleaf Toolkit 2020-08-19 13:31:17 +01:00
CHANGELOG.md Scripts to update config/overleaf.rc and config-seed rebrand (#217) 2024-04-02 16:43:08 +02:00
LICENSE Public release of the Overleaf Toolkit 2020-08-19 13:31:17 +01:00
README.md Make git clone commands match 2022-10-12 09:52:12 +01:00

README.md

Overleaf Toolkit

This repository contains the Overleaf Toolkit, the standard tools for running a local instance of Overleaf. This toolkit will help you to set up and administer both Overleaf Community Edition (free to use, and community supported), and Overleaf Server Pro (commercial, with professional support).

The Developer wiki contains further documentation on releases, features and other configuration elements.

Getting Started

Clone this repository locally:

git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit

Then follow the Quick Start Guide.

Documentation

See Documentation Index

Contributing

See the CONTRIBUTING file.

Getting Help

Users of the free Community Edition should open an issue on github.

Users of Server Pro should contact support@overleaf.com for assistance.

In both cases, it is a good idea to include the output of the bin/doctor script in your message.