changeset 2806:008d9c6f7c92 beta

fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
author H Waldo G <gwaldo@gmail.com>
date Wed, 05 Sep 2012 12:31:15 -0400
parents 2454ed7f0c21
children 57456b1c215b
files docs/installation.rst docs/upgrade.rst
diffstat 2 files changed, 55 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/docs/installation.rst	Wed Sep 05 01:39:13 2012 +0200
+++ b/docs/installation.rst	Wed Sep 05 12:31:15 2012 -0400
@@ -11,8 +11,8 @@
 **1.6**. If you're using older client, please upgrade.
 
 
-Installing RhodeCode from Cheese Shop
--------------------------------------
+Installing RhodeCode from PyPI (aka "Cheeseshop")
+-------------------------------------------------
 
 Rhodecode requires python version 2.5 or higher.
 
@@ -126,4 +126,4 @@
 .. _python: http://www.python.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _celery: http://celeryproject.org/
-.. _rabbitmq: http://www.rabbitmq.com/
\ No newline at end of file
+.. _rabbitmq: http://www.rabbitmq.com/
--- a/docs/upgrade.rst	Wed Sep 05 01:39:13 2012 +0200
+++ b/docs/upgrade.rst	Wed Sep 05 12:31:15 2012 -0400
@@ -4,14 +4,43 @@
 Upgrade
 =======
 
-Upgrading from Cheese Shop
---------------------------
+Upgrading from PyPI (aka "Cheeseshop")
+---------------------------------------
 
 .. note::
-   Firstly, it is recommended that you **always** perform a database backup 
-   before doing an upgrade.
+   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 
+   backed up to ``production.ini.1-3-6``.)
+
+
+If using a sqlite database, stop the Rhodecode process/daemon/service, and
+then make a copy of the database file::
+
+ service rhodecode stop
+ cp rhodecode.db rhodecode.db.{version}
+
 
-The easiest way to upgrade ``rhodecode`` is to run::
+Back up your configuration file::
+
+ cp production.ini production.ini.{version}
+
+
+Ensure that you are using the Python Virtual Environment that you'd originally
+installed Rhodecode in::
+
+ pip freeze
+
+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
+
+
+Once you have verified the environment you can upgrade ``Rhodecode`` with::
 
  easy_install -U rhodecode
 
@@ -20,14 +49,13 @@
  pip install --upgrade rhodecode
 
 
-Then make sure you run the following command from the installation directory::
+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 always better
-to make a backup of your configuration file before hand and re check the 
-content after the automerge.
+current configuration. It will try to perform an automerge. It's recommended 
+that you re-check the content after the automerge.
 
 .. note::
    Please always make sure your .ini files are up to date. Often errors are
@@ -41,12 +69,25 @@
 
 The final step is to upgrade the database. To do this simply run::
 
-    paster upgrade-db production.ini
+ 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 
 options that need to be set.
 
+You may find it helpful to clear out your log file so that new errors are 
+readily apparent::
+
+ echo > rhodecode.log
+
+Once that is complete, you may now start your upgraded Rhodecode Instance::
+
+ service rhodecode start
+
+Or::
+
+ paster serve /var/www/rhodecode/production.ini
+
 .. note::
    If you're using Celery, make sure you restart all instances of it after
    upgrade.
@@ -55,4 +96,4 @@
 .. _python: http://www.python.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _celery: http://celeryproject.org/
-.. _rabbitmq: http://www.rabbitmq.com/
\ No newline at end of file
+.. _rabbitmq: http://www.rabbitmq.com/