diff --git a/docs/upgrade.rst b/docs/upgrade.rst --- a/docs/upgrade.rst +++ b/docs/upgrade.rst @@ -8,12 +8,12 @@ Upgrading from PyPI (aka "Cheeseshop") --------------------------------------- .. note:: - Firstly, it is recommended that you **always** perform a database and + Firstly, it is recommended that you **always** perform a database and configuration backup before doing an upgrade. - - (These directions will use '{version}' to note that this is the version of - Rhodecode that these files were used with. If backing up your RhodeCode - instance from version 1.3.6 to 1.4.0, the ``production.ini`` file would be + + (These directions will use '{version}' to note that this is the version of + Rhodecode that these files were used with. If backing up your RhodeCode + instance from version 1.3.6 to 1.4.0, the ``production.ini`` file would be backed up to ``production.ini.1-3-6``.) @@ -34,7 +34,7 @@ installed Rhodecode in:: pip freeze -will list all packages installed in the current environment. If Rhodecode +will list all packages installed in the current environment. If Rhodecode isn't listed, change virtual environments to your venv location:: source /opt/rhodecode-venv/bin/activate @@ -50,11 +50,11 @@ Or:: Then run the following command from the installation directory:: - + paster make-config RhodeCode production.ini - + This will display any changes made by the new version of RhodeCode to your -current configuration. It will try to perform an automerge. It's recommended +current configuration. It will try to perform an automerge. It's recommended that you re-check the content after the automerge. .. note:: @@ -62,7 +62,7 @@ that you re-check the content after the caused by missing params added in new versions. -It is also recommended that you rebuild the whoosh index after upgrading since +It is also recommended that you rebuild the whoosh index after upgrading since the new whoosh version could introduce some incompatible index changes. Please Read the changelog to see if there were any changes to whoosh. @@ -70,12 +70,20 @@ Read the changelog to see if there were The final step is to upgrade the database. To do this simply run:: paster upgrade-db production.ini - + This will upgrade the schema and update some of the defaults in the database, -and will always recheck the settings of the application, if there are no new +and will always recheck the settings of the application, if there are no new options that need to be set. -You may find it helpful to clear out your log file so that new errors are + +.. note:: + DB schema upgrade library has some limitations and can sometimes fail if you try to + upgrade from older major releases. In such case simply run upgrades sequentially, eg. + upgrading from 1.2.X to 1.5.X should be done like that: 1.2.X. > 1.3.X > 1.4.X > 1.5.X + You can always specify what version of RhodeCode you want to install for example in pip + `pip install RhodeCode==1.3.6` + +You may find it helpful to clear out your log file so that new errors are readily apparent:: echo > rhodecode.log @@ -92,7 +100,7 @@ Or:: If you're using Celery, make sure you restart all instances of it after upgrade. -.. _virtualenv: http://pypi.python.org/pypi/virtualenv +.. _virtualenv: http://pypi.python.org/pypi/virtualenv .. _python: http://www.python.org/ .. _mercurial: http://mercurial.selenic.com/ .. _celery: http://celeryproject.org/