Mercurial > kallithea

annotate docs/upgrade.rst @ 2854:d998cc84cf72 rhodecode-0.0.1.4.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge branch beta into stable
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 19 Sep 2012 22:38:12 +0200
parents f7a52d548fd0
children 1a498b11f154
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
640
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _upgrade:
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
2095
Marcin Kuzminski <marcin@python-works.com>
parents: 2094
diff changeset
3 =======
640
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
4 Upgrade
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5 =======
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6
2806
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
7 Upgrading from PyPI (aka "Cheeseshop")
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
8 ---------------------------------------
640
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
9
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
10 .. note::
2806
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
11 Firstly, it is recommended that you **always** perform a database and
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
12 configuration backup before doing an upgrade.
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
13
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
14 (These directions will use '{version}' to note that this is the version of
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
15 Rhodecode that these files were used with. If backing up your RhodeCode
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
16 instance from version 1.3.6 to 1.4.0, the ``production.ini`` file would be
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
17 backed up to ``production.ini.1-3-6``.)
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
18
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
19
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
20 If using a sqlite database, stop the Rhodecode process/daemon/service, and
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
21 then make a copy of the database file::
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
22
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
23 service rhodecode stop
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
24 cp rhodecode.db rhodecode.db.{version}
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
25
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
26
2806
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
27 Back up your configuration file::
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
28
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
29 cp production.ini production.ini.{version}
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
30
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
31
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
32 Ensure that you are using the Python Virtual Environment that you'd originally
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
33 installed Rhodecode in::
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
34
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
35 pip freeze
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
36
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
37 will list all packages installed in the current environment. If Rhodecode
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
38 isn't listed, change virtual environments to your venv location::
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
39
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
40 source /opt/rhodecode-venv/bin/activate
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
41
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
42
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
43 Once you have verified the environment you can upgrade ``Rhodecode`` with::
640
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
44
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
45 easy_install -U rhodecode
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
46
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
47 Or::
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
48
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
49 pip install --upgrade rhodecode
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
50
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
51
2806
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
52 Then run the following command from the installation directory::
640
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
53
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
54 paster make-config RhodeCode production.ini
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
55
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
56 This will display any changes made by the new version of RhodeCode to your
2806
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
57 current configuration. It will try to perform an automerge. It's recommended
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
58 that you re-check the content after the automerge.
640
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
59
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
60 .. note::
2094
Marcin Kuzminski <marcin@python-works.com>
parents: 2071
diff changeset
61 Please always make sure your .ini files are up to date. Often errors are
2071
8330d5778ba3 upgrade docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
62 caused by missing params added in new versions.
8330d5778ba3 upgrade docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
63
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
64
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
65 It is also recommended that you rebuild the whoosh index after upgrading since
2071
8330d5778ba3 upgrade docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
66 the new whoosh version could introduce some incompatible index changes. Please
8330d5778ba3 upgrade docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
67 Read the changelog to see if there were any changes to whoosh.
845
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 661
diff changeset
68
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 661
diff changeset
69
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
70 The final step is to upgrade the database. To do this simply run::
845
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 661
diff changeset
71
2806
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
72 paster upgrade-db production.ini
845
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 661
diff changeset
73
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
74 This will upgrade the schema and update some of the defaults in the database,
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
75 and will always recheck the settings of the application, if there are no new
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
76 options that need to be set.
845
a040597b070b docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 661
diff changeset
77
2806
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
78 You may find it helpful to clear out your log file so that new errors are
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
79 readily apparent::
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
80
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
81 echo > rhodecode.log
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
82
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
83 Once that is complete, you may now start your upgraded Rhodecode Instance::
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
84
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
85 service rhodecode start
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
86
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
87 Or::
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
88
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
89 paster serve /var/www/rhodecode/production.ini
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
90
2115
8dfb265fc954 added info to ugprade docs to restart celery
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
91 .. note::
8dfb265fc954 added info to ugprade docs to restart celery
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
92 If you're using Celery, make sure you restart all instances of it after
8dfb265fc954 added info to ugprade docs to restart celery
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
93 upgrade.
640
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
94
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
95 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
96 .. _python: http://www.python.org/
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
97 .. _mercurial: http://mercurial.selenic.com/
afd98d1f817e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
98 .. _celery: http://celeryproject.org/
2806
008d9c6f7c92 fleshing out the Upgrade doc, and modified the references to Cheeseshop in the Install doc
H Waldo G <gwaldo@gmail.com>
parents: 2115
diff changeset
99 .. _rabbitmq: http://www.rabbitmq.com/