Mercurial > kallithea

comparison README.rst @ 5477:6f60bd9090b1 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
release: merge default to stable for 0.3
author Mads Kiilerich <madski@unity3d.com>
date Sun, 06 Sep 2015 23:36:05 +0200
parents c3d83238afa1
children 57caeb60c52b
comparison
equal deleted inserted replaced
5267:763dc7a96bae 5477:6f60bd9090b1
1 ================ 1 ================
2 Kallithea README 2 Kallithea README
3 ================ 3 ================
4
4 5
5 About 6 About
6 ----- 7 -----
7 8
8 **Kallithea** is a fast and powerful management tool for Mercurial_ and Git_ 9 **Kallithea** is a fast and powerful management tool for Mercurial_ and Git_
19 created by Łukasz Balcerzak and Marcin Kuźmiński to uniformly handle multiple 20 created by Łukasz Balcerzak and Marcin Kuźmiński to uniformly handle multiple
20 version control systems. 21 version control systems.
21 22
22 Kallithea was forked from RhodeCode in July 2014 and has been heavily modified. 23 Kallithea was forked from RhodeCode in July 2014 and has been heavily modified.
23 24
25
24 Installation 26 Installation
25 ------------ 27 ------------
26 Official releases of Kallithea can be installed via:: 28
29 Kallithea requires Python_ 2.x and it is recommended to install it in a
30 virtualenv_. Official releases of Kallithea can be installed with::
27 31
28 pip install kallithea 32 pip install kallithea
29 33
30 The development repository is kept very stable and used in production by the 34 The development repository is kept very stable and used in production by the
31 developers - you can do the same. 35 developers -- you can do the same.
32 36
33 Please visit https://docs.kallithea-scm.org/en/latest/installation.html for 37 Please visit https://docs.kallithea-scm.org/en/latest/installation.html for
34 more details. 38 more details.
35 39
36 40
42 46
43 The issue tracker and a repository mirror can be found at Bitbucket_ on 47 The issue tracker and a repository mirror can be found at Bitbucket_ on
44 https://bitbucket.org/conservancy/kallithea. 48 https://bitbucket.org/conservancy/kallithea.
45 49
46 50
47 51 Kallithea features
48 Kallithea Features
49 ------------------ 52 ------------------
50 53
51 - Has its own middleware to handle Mercurial_ and Git_ protocol requests. Each 54 - Has its own middleware to handle Mercurial_ and Git_ protocol requests. Each
52 request is authenticated and logged together with IP address. 55 request is authenticated and logged together with IP address.
53 - Built for speed and performance. You can make multiple pulls/pushes 56 - Built for speed and performance. You can make multiple pulls/pushes
113 116
114 Community 117 Community
115 --------- 118 ---------
116 119
117 **Kallithea** is maintained by its users who contribute the fixes they would 120 **Kallithea** is maintained by its users who contribute the fixes they would
118 like to see. 121 like to see.
119 122
120 Get in touch with the rest of the community: 123 Get in touch with the rest of the community:
121 124
122 - Join the mailing list users and developers - see 125 - Join the mailing list users and developers -- see
123 http://lists.sfconservancy.org/mailman/listinfo/kallithea-general. 126 http://lists.sfconservancy.org/mailman/listinfo/kallithea-general.
124 127
125 - Use IRC and join #kallithea on FreeNode (irc.freenode.net) or use 128 - Use IRC and join #kallithea on FreeNode (irc.freenode.net) or use
126 http://webchat.freenode.net/?channels=kallithea. 129 http://webchat.freenode.net/?channels=kallithea.
127 130
159 database: 162 database:
160 163
161 - keep the database unconverted (intended for testing and evaluation) 164 - keep the database unconverted (intended for testing and evaluation)
162 - convert the database in a one-time step 165 - convert the database in a one-time step
163 166
164 Maintaining Interoperability 167 Maintaining interoperability
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 168 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166 169
167 Interoperability with RhodeCode 2.2.X installations is provided so you don't 170 Interoperability with RhodeCode 2.2.X installations is provided so you don't
168 have to immediately commit to switching to Kallithea. This option will most 171 have to immediately commit to switching to Kallithea. This option will most
169 likely go away once the two projects have diverged significantly. 172 likely go away once the two projects have diverged significantly.
178 python setup.py install 181 python setup.py install
179 182
180 then you will find this location at 183 then you will find this location at
181 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``. 184 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``.
182 185
183 One-time Conversion 186 One-time conversion
184 ~~~~~~~~~~~~~~~~~~~ 187 ~~~~~~~~~~~~~~~~~~~
185 188
186 Alternatively, if you would like to convert the database for good, you can use 189 Alternatively, if you would like to convert the database for good, you can use
187 a helper script provided by Kallithea. This script will operate directly on the 190 a helper script provided by Kallithea. This script will operate directly on the
188 database, using the database string you can find in your ``production.ini`` (or 191 database, using the database string you can find in your ``production.ini`` (or
195 198
196 .. Note:: 199 .. Note::
197 200
198 If you started out using the branding interoperability approach mentioned 201 If you started out using the branding interoperability approach mentioned
199 above, watch out for stray brand.pyc after removing brand.py. 202 above, watch out for stray brand.pyc after removing brand.py.
203
204 Git hooks
205 ~~~~~~~~~
206
207 After switching to Kallithea, it will be necessary to update the Git_ hooks in
208 your repositories. If not, the Git_ hooks from RhodeCode will still be called,
209 which will cause ``git push`` to fail every time.
210
211 If you do not have any custom Git_ hooks deployed, perform the following steps
212 (this may take some time depending on the number and size of repositories you
213 have):
214
215 1. Log-in as an administrator.
216
217 2. Open page *Admin > Settings > Remap and Rescan*.
218
219 3. Turn on the option **Install Git Hooks**.
220
221 4. Turn on the option **Overwrite existing Git hooks**.
222
223 5. Click on the button **Rescan Repositories**.
224
225 If you do have custom hooks, you will need to merge those changes manually. In
226 order to get sample hooks from Kallithea, the easiest way is to create a new Git_
227 repository, and have a look at the hooks deployed there.
228
200 229
201 .. _virtualenv: http://pypi.python.org/pypi/virtualenv 230 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
202 .. _Python: http://www.python.org/ 231 .. _Python: http://www.python.org/
203 .. _Sphinx: http://sphinx.pocoo.org/ 232 .. _Sphinx: http://sphinx.pocoo.org/
204 .. _Mercurial: http://mercurial.selenic.com/ 233 .. _Mercurial: http://mercurial.selenic.com/