Mercurial > kallithea

comparison docs/installation.rst @ 5434:8867673c8192

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: consistent spacing between text
author Mads Kiilerich <madski@unity3d.com>
date Wed, 26 Aug 2015 17:28:58 +0200
parents fbbe80e3322b
children ae9ab4c92d46
comparison
equal deleted inserted replaced
5433:fbbe80e3322b 5434:8867673c8192
121 These directions will use '{version}' to note that this is the version of 121 These directions will use '{version}' to note that this is the version of
122 Kallithea that these files were used with. If backing up your Kallithea 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 123 instance from version 0.1 to 0.2, the ``my.ini`` file could be
124 backed up to ``my.ini.0-1``. 124 backed up to ``my.ini.0-1``.
125 125
126
127 If using a SQLite database, stop the Kallithea process/daemon/service, and 126 If using a SQLite database, stop the Kallithea process/daemon/service, and
128 then make a copy of the database file:: 127 then make a copy of the database file::
129 128
130 service kallithea stop 129 service kallithea stop
131 cp kallithea.db kallithea.db.{version} 130 cp kallithea.db kallithea.db.{version}
132 131
133
134 Back up your configuration file:: 132 Back up your configuration file::
135 133
136 cp my.ini my.ini.{version} 134 cp my.ini my.ini.{version}
137
138 135
139 Ensure that you are using the Python virtual environment that you originally 136 Ensure that you are using the Python virtual environment that you originally
140 installed Kallithea in by running:: 137 installed Kallithea in by running::
141 138
142 pip freeze 139 pip freeze
144 This will list all packages installed in the current environment. If 141 This will list all packages installed in the current environment. If
145 Kallithea isn't listed, activate the correct virtual environment:: 142 Kallithea isn't listed, activate the correct virtual environment::
146 143
147 source /srv/kallithea/venv/bin/activate 144 source /srv/kallithea/venv/bin/activate
148 145
149
150 Once you have verified the environment you can upgrade Kallithea with:: 146 Once you have verified the environment you can upgrade Kallithea with::
151 147
152 pip install --upgrade kallithea 148 pip install --upgrade kallithea
153
154 149
155 Then run the following command from the installation directory:: 150 Then run the following command from the installation directory::
156 151
157 paster make-config Kallithea my.ini 152 paster make-config Kallithea my.ini
158 153
162 157
163 .. note:: 158 .. note::
164 Please always make sure your .ini files are up to date. Errors can 159 Please always make sure your .ini files are up to date. Errors can
165 often be caused by missing parameters added in new versions. 160 often be caused by missing parameters added in new versions.
166 161
167
168 It is also recommended that you rebuild the whoosh index after upgrading since 162 It is also recommended that you rebuild the whoosh index after upgrading since
169 the new whoosh version could introduce some incompatible index changes. Please 163 the new whoosh version could introduce some incompatible index changes. Please
170 read the changelog to see if there were any changes to whoosh. 164 read the changelog to see if there were any changes to whoosh.
171 165
172
173 The final step is to upgrade the database. To do this simply run:: 166 The final step is to upgrade the database. To do this simply run::
174 167
175 paster upgrade-db my.ini 168 paster upgrade-db my.ini
176 169
177 This will upgrade the schema and update some of the defaults in the database, 170 This will upgrade the schema and update some of the defaults in the database,
178 and will always recheck the settings of the application, if there are no new 171 and will always recheck the settings of the application, if there are no new
179 options that need to be set. 172 options that need to be set.
180
181 173
182 .. note:: 174 .. note::
183 The DB schema upgrade library has some limitations and can sometimes fail if you try to 175 The DB schema upgrade library has some limitations and can sometimes fail if you try to
184 upgrade from older major releases. In such a case simply run upgrades sequentially, e.g., 176 upgrade from older major releases. In such a case simply run upgrades sequentially, e.g.,
185 upgrading from 0.1.X to 0.3.X should be done like this: 0.1.X. > 0.2.X > 0.3.X 177 upgrading from 0.1.X to 0.3.X should be done like this: 0.1.X. > 0.2.X > 0.3.X