Mercurial > kallithea

annotate docs/installation.rst @ 5414:d9386a3924db

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
vcs: invalidate repo caches _after_ a push finishes Caches were invalidated right after creating the result iterator, before actually applying the change. Caches would thus be refreshed too early and soon be outdated. This bug was especially seen causing errors with missing revisions when creating PRs right after pushing.
author Mads Kiilerich <madski@unity3d.com>
date Thu, 20 Aug 2015 17:29:55 +0200
parents 22a3fa3c4254
children 5ae8e644aa88
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents: 4989
diff changeset
7 Here are more details about 3 ways to install Kallithea:
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
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
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents: 4989
diff changeset
10 uptodate and keep track of local customizations is to run directly from
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents: 4989
diff changeset
11 source in a Kallithea repository clone and use virtualenv.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
12
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
13 - :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
14 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
15 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
16 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
17 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
18 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
19 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
20
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
21 - :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
22 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
23 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
24 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
25 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
26 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
27
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
28 .. _installation-source:
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
29
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
30 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
31 -----------------------------------
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
32
4989
8927a1ac8d41 docs: prepare for having a stable development branch
Mads Kiilerich <madski@unity3d.com>
parents: 4986
diff changeset
33 To install Kallithea in a virtualenv using the stable branch of the development
8927a1ac8d41 docs: prepare for having a stable development branch
Mads Kiilerich <madski@unity3d.com>
parents: 4986
diff changeset
34 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
35
4989
8927a1ac8d41 docs: prepare for having a stable development branch
Mads Kiilerich <madski@unity3d.com>
parents: 4986
diff changeset
36 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
37 cd kallithea
5e66d3ec9880 docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4914
diff changeset
38 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
39 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
40 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
41 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
42
5e66d3ec9880 docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4914
diff changeset
43 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
44
5e66d3ec9880 docs/installation: add section on installation from repository source
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4914
diff changeset
45 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
46 server.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
47
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
48 .. _installation-virtualenv:
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 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
51 ---------------------------------------------
2358
69df04ee1e2b added detailed step-by-step installation instruction for windows
Marcin Kuzminski <marcin@python-works.com>
parents: 2351
diff changeset
52
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
53 It is highly recommended to use a separate virtualenv_ for installing Kallithea.
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
54 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
55 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
56 problematic when upgrading the system or Kallithea.
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4925
diff changeset
57 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
58
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
59 - 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
60 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
61
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
62 virtualenv /srv/kallithea/venv
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
63
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
64 - 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
65
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
66 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
67
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
68 .. 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
69 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
70 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
71
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3700
diff changeset
72 - 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
73 filesystem. For example::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
74
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
75 mkdir /srv/kallithea
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3169
diff changeset
76
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4925
diff changeset
77 - 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
78
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3700
diff changeset
79 pip install kallithea
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3169
diff changeset
80
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
81 Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
82 extract it and run::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
83
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
84 python setup.py install
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
85
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4925
diff changeset
86 - This will install Kallithea together with pylons_ and all other required
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
87 python libraries into the activated virtualenv.
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
88
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
89 You can now proceed to :ref:`setup`.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
90
4924
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
91 .. _installation-without-virtualenv:
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
92
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
93 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
94 ------------------------------------------------
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
95
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
96 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
97
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
98 pip install kallithea
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 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
101 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
102
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
103 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
104
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
105 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
106
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4922
diff changeset
107 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
108
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
109 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
110 ----------------------------------------------------
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
111
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
112 .. note::
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4925
diff changeset
113 It is strongly recommended that you **always** perform a database and
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
114 configuration backup before doing an upgrade.
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
115
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4925
diff changeset
116 These directions will use '{version}' to note that this is the version of
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
117 Kallithea that these files were used with. If backing up your Kallithea
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
118 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
119 backed up to ``my.ini.0-1``.
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
120
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
121
4914
95fe05b1e5f8 docs: better capitalisation
Andrew Shadura <andrew@shadura.me>
parents: 4912
diff changeset
122 If using a SQLite database, stop the Kallithea process/daemon/service, and
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
123 then make a copy of the database file::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
124
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
125 service kallithea stop
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
126 cp kallithea.db kallithea.db.{version}
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
127
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
128
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
129 Back up your configuration file::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
130
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
131 cp my.ini my.ini.{version}
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
132
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
133
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4925
diff changeset
134 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
135 installed Kallithea in by running::
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
136
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
137 pip freeze
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
138
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4925
diff changeset
139 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
140 Kallithea isn't listed, activate the correct virtual environment::
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
141
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
142 source /srv/kallithea/venv/bin/activate
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
143
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
144
4912
295900ff473d docs: don't use fixed-width fonts when not needed
Andrew Shadura <andrew@shadura.me>
parents: 4902
diff changeset
145 Once you have verified the environment you can upgrade Kallithea with::
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
146
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
147 pip install --upgrade kallithea
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
148
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
149
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
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
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
152 paster make-config Kallithea my.ini
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
153
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
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
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
157
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
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
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
161
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
162
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
163 It is also recommended that you rebuild the whoosh index after upgrading since
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
164 the new whoosh version could introduce some incompatible index changes. Please
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
165 read the changelog to see if there were any changes to whoosh.
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
166
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
167
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
168 The final step is to upgrade the database. To do this simply run::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
169
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
170 paster upgrade-db my.ini
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
171
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
172 This will upgrade the schema and update some of the defaults in the database,
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
173 and will always recheck the settings of the application, if there are no new
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
174 options that need to be set.
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
175
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
176
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
177 .. note::
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4925
diff changeset
178 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
179 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
180 upgrading from 0.1.X to 0.3.X should be done like this: 0.1.X. > 0.2.X > 0.3.X
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
181 You can always specify what version of Kallithea you want to install for example in pip
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
182 `pip install Kallithea==0.2`
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
183
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
184 You may find it helpful to clear out your log file so that new errors are
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
185 readily apparent::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
186
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
187 echo > kallithea.log
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
188
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
189 Once that is complete, you may now start your upgraded Kallithea Instance::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
190
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
191 service kallithea start
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
192
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
193 Or::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
194
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
195 paster serve /srv/kallithea/my.ini
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
196
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
197 .. note::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
198 If you're using Celery, make sure you restart all instances of it after
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4814
diff changeset
199 upgrade.
855
8bbe9ab76371 cleaned installation docs a little
Marcin Kuzminski <marcin@python-works.com>
parents: 845
diff changeset
200
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
201
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3169
diff changeset
202 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4925
diff changeset
203 .. _pylons: http://www.pylonsproject.org/