overleaf / overleaf/toolkit

manual upgrade to 5.0 & OVERLEAF fails

Open
#253 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
1.3k
Forks
310
Avg merge
3d 12h
Merged PRs (30d)
1

Description

Running
bin/up
ends up in

Initiating Mongo replica set...
time="2024-05-21T09:44:01+02:00" level=warning msg="The "SHARELATEX_DATA_PATH" variable is not set. Defaulting to a blank string."
invalid spec: :/var/lib/sharelatex: empty section between colons

Specifying SHARELATEX_DATA_PATH
results in

Initiating Mongo replica set...
Rebranding from ShareLaTeX to Overleaf
The Toolkit has adopted to Overleaf brand for its variables.
Your config/overleaf.rc still has 1 variables using the previous ShareLaTeX brand.
Moving forward the 'SHARELATEX_' prefixed variables must be renamed to 'OVERLEAF_'.
You can migrate your config/overleaf.rc to use the Overleaf brand by running:
toolkit$ bin/rename-rc-vars

How to escape this dilemma?
Where to find a step-by-step description, what to do instead of an interrupted bin/upgrade?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with bin/up and bin/upgrade, then inspect config/overleaf.rc and bin/rename-rc-vars to understand the failed manual upgrade path and variable migration. Reproduce the missing SHARELATEX_DATA_PATH error and confirm a documented recovery or upgrade path that completes without leaving the installation interrupted.

Written by the indexing model from the issue text.

Assessment

Tech stack
mongodb, shell
Domain
databases, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.