diff --git a/README.md b/README.md index 2ac12723b6..405ba6406f 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,17 @@ Once you are logged in as an admin user, you can visit `/admin/register` on your *Please make sure to back up all Mongo, Redis and on-disk data before upgrading.* -Stop and remove the currently running ShareLaTeX container: +#### Migrations +Data stored in Mongodb will be automatically migrated to the latest schemea when upgrading docker releases. **This can make downgrades impossible.** One recommended technique is to test the migration first. This can be done by copying the mongodb database and doing a test run against the copied data. + +``` +db.copyDatabase(sharelatex,sharelatex-copy) +# start the container up pointing at the new db +--env SHARELATEX_MONGO_URL=mongodb://dockerhost/sharelatex-copy +``` + +#### Upgrade process +To use the new docker container stop and remove the currently running ShareLaTeX container: ``` $ docker stop sharelatex