Mercurial > kallithea
annotate docs/upgrade.rst @ 4324:494eab6ec837
pull requests: shorten revision numbers in automatic titles
- but it would perhaps be better to use branch names ...
author | Mads Kiilerich <madski@unity3d.com> |
---|---|
date | Fri, 04 Jul 2014 14:12:06 +0200 |
parents | e73a69cb98dc |
children |
rev | line source |
---|---|
640 | 1 .. _upgrade: |
2 | |
2095 | 3 ======= |
640 | 4 Upgrade |
5 ======= | |
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 | 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:: |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
11 Firstly, it is recommended that you **always** perform a database and |
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
|
12 configuration backup before doing an upgrade. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
13 |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
14 (These directions will use '{version}' to note that this is the version of |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
15 Kallithea that these files were used with. If backing up your Kallithea |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
16 instance from version 1.3.6 to 1.4.0, the ``production.ini`` file would be |
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
|
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 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
20 If using a sqlite database, stop the Kallithea process/daemon/service, and |
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
|
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 |
4190
99ad9d0af1a3
Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3700
diff
changeset
|
23 service kallithea stop |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
24 cp kallithea.db kallithea.db.{version} |
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
|
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 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
33 installed Kallithea in:: |
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
|
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 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
37 will list all packages installed in the current environment. If Kallithea |
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
|
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 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
40 source /opt/kallithea-venv/bin/activate |
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
|
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 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
43 Once you have verified the environment you can upgrade ``Kallithea`` with:: |
640 | 44 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
45 easy_install -U kallithea |
640 | 46 |
47 Or:: | |
48 | |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
49 pip install --upgrade kallithea |
640 | 50 |
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:: |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
53 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
54 paster make-config Kallithea production.ini |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
55 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
56 This will display any changes made by the new version of Kallithea to your |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
57 current configuration. It will try to perform an automerge. It's recommended |
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
|
58 that you re-check the content after the automerge. |
640 | 59 |
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
845
diff
changeset
|
60 .. note:: |
2094 | 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 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
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 | 68 |
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 | 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 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
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, |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
75 and will always recheck the settings of the application, if there are no new |
1123 | 76 options that need to be set. |
845 | 77 |
3335 | 78 |
79 .. note:: | |
80 DB schema upgrade library has some limitations and can sometimes fail if you try to | |
81 upgrade from older major releases. In such case simply run upgrades sequentially, eg. | |
82 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 | |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
83 You can always specify what version of Kallithea you want to install for example in pip |
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
84 `pip install Kallithea==1.3.6` |
3335 | 85 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
86 You may find it helpful to clear out your log file so that new errors are |
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
|
87 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
|
88 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
89 echo > kallithea.log |
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
|
90 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
91 Once that is complete, you may now start your upgraded Kallithea Instance:: |
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
|
92 |
4190
99ad9d0af1a3
Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3700
diff
changeset
|
93 service kallithea start |
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
|
94 |
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
|
95 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
|
96 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4190
diff
changeset
|
97 paster serve /var/www/kallithea/production.ini |
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
|
98 |
2115
8dfb265fc954
added info to ugprade docs to restart celery
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
99 .. note:: |
8dfb265fc954
added info to ugprade docs to restart celery
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
100 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
|
101 upgrade. |
640 | 102 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2806
diff
changeset
|
103 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
640 | 104 .. _python: http://www.python.org/ |
105 .. _mercurial: http://mercurial.selenic.com/ | |
106 .. _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
|
107 .. _rabbitmq: http://www.rabbitmq.com/ |