Merge pull request #18770 from overleaf/jpa-fph-migration-docs

[web] add documentation for full project history migration check

GitOrigin-RevId: 4a7e5a734d7fd4a2ca0a4315f57929809937e842
This commit is contained in:
Jakob Ackermann 2024-06-10 10:41:39 +02:00 committed by Copybot
parent fb27046936
commit fb2e3b3a25

View file

@ -1,3 +1,6 @@
const { promisify } = require('util')
const sleep = promisify(setTimeout)
exports.tags = ['server-ce', 'server-pro']
exports.migrate = async client => {
@ -6,6 +9,39 @@ exports.migrate = async client => {
'overleaf.history.display': { $ne: true },
})
if (count > 0) {
console.error(`
-----------------------------------------------------------------------
Full Project History migration not completed for ${count} projects.
Starting with Server Pro/Community Edition version 4.0,
all projects must use the full project history feature.
Release 3.5 includes a migration process. Please go back to version
3.5 and run through the migration process:
Overleaf Toolkit setups:
toolkit$ echo "3.5.13" > config/version
toolkit$ bin/up
Legacy docker compose setups/Horizontal scaling setups:
Update the image tag for "services -> sharelatex" to
Server Pro: quay.io/sharelatex/sharelatex-pro:3.5.13.
Community Edition: sharelatex/sharelatex:3.5.13
Then use "docker compose up" to apply the changes.
Documentation for the migration process:
https://github.com/overleaf/overleaf/wiki/Full-Project-History-Migration
Refusing to start up, exiting in 10s.
-----------------------------------------------------------------------
`)
await sleep(10_000)
throw new Error(
`Found ${count} projects not migrated to Full Project History`
)