Mercurial > kallithea
annotate docs/installation.rst @ 5437:3f017db297c4
javascript: use jQuery .prop instead of .attr for standard properties
author | Mads Kiilerich <madski@unity3d.com> |
---|---|
date | Wed, 26 Aug 2015 17:28:59 +0200 |
parents | 8867673c8192 |
children | ae9ab4c92d46 |
rev | line source |
---|---|
568
5f481e4e888b
updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
1 .. _installation: |
5f481e4e888b
updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
2 |
4814
d95ea48af67b
docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs
Mads Kiilerich <madski@unity3d.com>
parents:
4522
diff
changeset
|
3 ========================== |
d95ea48af67b
docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs
Mads Kiilerich <madski@unity3d.com>
parents:
4522
diff
changeset
|
4 Installation on Unix/Linux |
d95ea48af67b
docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs
Mads Kiilerich <madski@unity3d.com>
parents:
4522
diff
changeset
|
5 ========================== |
568
5f481e4e888b
updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
6 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
7 The following describes three different ways of installing Kallithea: |
4902 | 8 |
5081
154becd92f40
docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents:
4989
diff
changeset
|
9 - :ref:`installation-source`: The simplest way to keep the installation |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
10 up-to-date and track any local customizations is to run directly from |
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
11 source in a Kallithea repository clone, preferably inside a virtualenv |
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
12 virtual Python environment. |
568
5f481e4e888b
updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
13 |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
14 - :ref:`installation-virtualenv`: If you prefer to only use released versions |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
15 of Kallithea, the recommended method is to install Kallithea in a virtual |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
16 Python environment using `virtualenv`. The advantages of this method over |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
17 direct installation is that Kallithea and its dependencies are completely |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
18 contained inside the virtualenv (which also means you can have multiple |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
19 installations side by side or remove it entirely by just removing the |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
20 virtualenv directory) and does not require root privileges. |
4922
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
21 |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
22 - :ref:`installation-without-virtualenv`: The alternative method of installing |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
23 a Kallithea release is using standard pip. The package will be installed in |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
24 the same location as all other Python packages you have ever installed. As a |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
25 result, removing it is not as straightforward as with a virtualenv, as you'd |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
26 have to remove its dependencies manually and make sure that they are not |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
27 needed by other packages. |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
28 |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
29 .. _installation-source: |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
30 |
5433
fbbe80e3322b
docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents:
5425
diff
changeset
|
31 |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
32 Installation from repository source |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
33 ----------------------------------- |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
34 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
35 To install Kallithea in a virtualenv_ using the stable branch of the development |
4989
8927a1ac8d41
docs: prepare for having a stable development branch
Mads Kiilerich <madski@unity3d.com>
parents:
4986
diff
changeset
|
36 repository, follow the instructions below:: |
4922
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
37 |
4989
8927a1ac8d41
docs: prepare for having a stable development branch
Mads Kiilerich <madski@unity3d.com>
parents:
4986
diff
changeset
|
38 hg clone https://kallithea-scm.org/repos/kallithea -u stable |
4922
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
39 cd kallithea |
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
40 virtualenv ../kallithea-venv |
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
41 source ../kallithea-venv/bin/activate |
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
42 python setup.py develop |
4986
7d6c4bd58abd
i18n: don't include .mo files in the repo - build them on demand
Mads Kiilerich <madski@unity3d.com>
parents:
4955
diff
changeset
|
43 python setup.py compile_catalog # for translation of the UI |
4922
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
44 |
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
45 You can now proceed to :ref:`setup`. |
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
46 |
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
47 To upgrade, simply update the repository with ``hg pull -u`` and restart the |
5e66d3ec9880
docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4914
diff
changeset
|
48 server. |
568
5f481e4e888b
updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
49 |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
50 .. _installation-virtualenv: |
568
5f481e4e888b
updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
51 |
5433
fbbe80e3322b
docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents:
5425
diff
changeset
|
52 |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
53 Installing a released version in a virtualenv |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
54 --------------------------------------------- |
2358
69df04ee1e2b
added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents:
2351
diff
changeset
|
55 |
4902 | 56 It is highly recommended to use a separate virtualenv_ for installing Kallithea. |
57 This way, all libraries required by Kallithea will be installed separately from your | |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
58 main Python installation and other applications and things will be less |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
59 problematic when upgrading the system or Kallithea. |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
60 An additional benefit of virtualenv_ is that it doesn't require root privileges. |
568
5f481e4e888b
updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
61 |
4902 | 62 - Assuming you have installed virtualenv_, create a new virtual environment |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
63 for example, in `/srv/kallithea/venv`, using the virtualenv command:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
64 |
4902 | 65 virtualenv /srv/kallithea/venv |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
66 |
4902 | 67 - Activate the virtualenv_ in your current shell session by running:: |
1092
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1062
diff
changeset
|
68 |
4902 | 69 source /srv/kallithea/venv/bin/activate |
1092
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1062
diff
changeset
|
70 |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
71 .. note:: You can't use UNIX ``sudo`` to source the ``virtualenv`` script; it |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
72 will "activate" a shell that terminates immediately. It is also perfectly |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
73 acceptable (and desirable) to create a virtualenv as a normal user. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3169
diff
changeset
|
74 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3700
diff
changeset
|
75 - Make a folder for Kallithea data files, and configuration somewhere on the |
1309
61a6a7bf2cbd
small docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
76 filesystem. For example:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
77 |
4902 | 78 mkdir /srv/kallithea |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3169
diff
changeset
|
79 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
80 - Go into the created directory and run this command to install Kallithea:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
81 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3700
diff
changeset
|
82 pip install kallithea |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3169
diff
changeset
|
83 |
4902 | 84 Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea, |
85 extract it and run:: | |
86 | |
87 python setup.py install | |
88 | |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
89 - This will install Kallithea together with pylons_ and all other required |
4902 | 90 python libraries into the activated virtualenv. |
91 | |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
92 You can now proceed to :ref:`setup`. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
568
diff
changeset
|
93 |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
94 .. _installation-without-virtualenv: |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
95 |
5433
fbbe80e3322b
docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents:
5425
diff
changeset
|
96 |
4924
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
97 Installing a released version without virtualenv |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
98 ------------------------------------------------ |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
99 |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
100 For installation without virtualenv, 'just' use:: |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
101 |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
102 pip install kallithea |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
103 |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
104 Note that this method requires root privileges and will install packages |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
105 globally without using the system's package manager. |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
106 |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
107 To install as a regular user in ``~/.local``, you can use:: |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
108 |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
109 pip install --user kallithea |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
110 |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
111 You can now proceed to :ref:`setup`. |
7c952ea3d7b3
docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4922
diff
changeset
|
112 |
5433
fbbe80e3322b
docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents:
5425
diff
changeset
|
113 |
4902 | 114 Upgrading Kallithea from Python Package Index (PyPI) |
5413
22a3fa3c4254
docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents:
5081
diff
changeset
|
115 ---------------------------------------------------- |
4902 | 116 |
117 .. note:: | |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
118 It is strongly recommended that you **always** perform a database and |
4902 | 119 configuration backup before doing an upgrade. |
120 | |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
121 These directions will use '{version}' to note that this is the version of |
4902 | 122 Kallithea that these files were used with. If backing up your Kallithea |
123 instance from version 0.1 to 0.2, the ``my.ini`` file could be | |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
124 backed up to ``my.ini.0-1``. |
4902 | 125 |
4914
95fe05b1e5f8
docs: better capitalisation
Andrew Shadura <andrew@shadura.me>
parents:
4912
diff
changeset
|
126 If using a SQLite database, stop the Kallithea process/daemon/service, and |
4902 | 127 then make a copy of the database file:: |
128 | |
129 service kallithea stop | |
130 cp kallithea.db kallithea.db.{version} | |
131 | |
132 Back up your configuration file:: | |
133 | |
134 cp my.ini my.ini.{version} | |
135 | |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
136 Ensure that you are using the Python virtual environment that you originally |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
137 installed Kallithea in by running:: |
4902 | 138 |
139 pip freeze | |
140 | |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
141 This will list all packages installed in the current environment. If |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
142 Kallithea isn't listed, activate the correct virtual environment:: |
4902 | 143 |
144 source /srv/kallithea/venv/bin/activate | |
145 | |
4912
295900ff473d
docs: don't use fixed-width fonts when not needed
Andrew Shadura <andrew@shadura.me>
parents:
4902
diff
changeset
|
146 Once you have verified the environment you can upgrade Kallithea with:: |
4902 | 147 |
148 pip install --upgrade kallithea | |
149 | |
150 Then run the following command from the installation directory:: | |
855
8bbe9ab76371
cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents:
845
diff
changeset
|
151 |
4902 | 152 paster make-config Kallithea my.ini |
153 | |
154 This will display any changes made by the new version of Kallithea to your | |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
155 current configuration. It will try to perform an automerge. It is recommended |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
156 that you recheck the content after the automerge. |
4902 | 157 |
158 .. note:: | |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
159 Please always make sure your .ini files are up to date. Errors can |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
160 often be caused by missing parameters added in new versions. |
4902 | 161 |
162 It is also recommended that you rebuild the whoosh index after upgrading since | |
163 the new whoosh version could introduce some incompatible index changes. Please | |
164 read the changelog to see if there were any changes to whoosh. | |
165 | |
166 The final step is to upgrade the database. To do this simply run:: | |
167 | |
168 paster upgrade-db my.ini | |
169 | |
170 This will upgrade the schema and update some of the defaults in the database, | |
171 and will always recheck the settings of the application, if there are no new | |
172 options that need to be set. | |
173 | |
174 .. note:: | |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
175 The DB schema upgrade library has some limitations and can sometimes fail if you try to |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
176 upgrade from older major releases. In such a case simply run upgrades sequentially, e.g., |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
177 upgrading from 0.1.X to 0.3.X should be done like this: 0.1.X. > 0.2.X > 0.3.X |
4902 | 178 You can always specify what version of Kallithea you want to install for example in pip |
179 `pip install Kallithea==0.2` | |
180 | |
181 You may find it helpful to clear out your log file so that new errors are | |
182 readily apparent:: | |
183 | |
184 echo > kallithea.log | |
185 | |
186 Once that is complete, you may now start your upgraded Kallithea Instance:: | |
187 | |
188 service kallithea start | |
189 | |
190 Or:: | |
191 | |
192 paster serve /srv/kallithea/my.ini | |
193 | |
194 .. note:: | |
195 If you're using Celery, make sure you restart all instances of it after | |
196 upgrade. | |
855
8bbe9ab76371
cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents:
845
diff
changeset
|
197 |
568
5f481e4e888b
updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
198 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3169
diff
changeset
|
199 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4925
diff
changeset
|
200 .. _pylons: http://www.pylonsproject.org/ |