Mercurial > kallithea
annotate README.rst @ 5963:85bb68f64597
notifications: improve response time when number of notifications is large
NotificationsController always retrieved materialized list of all notifications
in database, even to display only 10 of them. This is improved by feeding
SQLAlchemy Query object directly to webhelpers.paginate.Page, avoiding eager
load of all notifications.
author | Konstantin Veretennicov <kveretennicov@gmail.com> |
---|---|
date | Thu, 09 Jun 2016 20:41:44 +0200 |
parents | ed2fb6e84a02 |
children | 0b6d2ca7175f |
rev | line source |
---|---|
4902 | 1 ================ |
2 Kallithea README | |
3 ================ | |
2020 | 4 |
5433
fbbe80e3322b
docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents:
5425
diff
changeset
|
5 |
2020 | 6 About |
7 ----- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
8 |
4912
295900ff473d
docs: don't use fixed-width fonts when not needed
Andrew Shadura <andrew@shadura.me>
parents:
4902
diff
changeset
|
9 **Kallithea** is a fast and powerful management tool for Mercurial_ and Git_ |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
10 with a built-in push/pull server, full text search and code-review. It works on |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
11 http/https and has a built in permission/authentication system with the ability |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
12 to authenticate via LDAP or ActiveDirectory. Kallithea also provides simple API |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
13 so it's easy to integrate with existing external systems. |
1093 | 14 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
15 Kallithea is similar in some respects to GitHub_ or Bitbucket_, however |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
16 Kallithea can be run as standalone hosted application on your own server. It is |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
17 open-source donationware and focuses more on providing a customised, |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
18 self-administered interface for Mercurial_ and Git_ repositories. Kallithea |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
19 works on Unix-like systems and Windows, and is powered by the vcs_ library |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
20 created by Łukasz Balcerzak and Marcin Kuźmiński to uniformly handle multiple |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
21 version control systems. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
22 |
4236
9b5f8a8b2673
Declare this a fork in README.rst
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4235
diff
changeset
|
23 Kallithea was forked from RhodeCode in July 2014 and has been heavily modified. |
9b5f8a8b2673
Declare this a fork in README.rst
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4235
diff
changeset
|
24 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
25 |
2020 | 26 Installation |
27 ------------ | |
5433
fbbe80e3322b
docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents:
5425
diff
changeset
|
28 |
5401
11bc459d010b
docs: clarify Python 2 requirement in README
Mads Kiilerich <madski@unity3d.com>
parents:
4979
diff
changeset
|
29 Kallithea requires Python_ 2.x and it is recommended to install it in a |
11bc459d010b
docs: clarify Python 2 requirement in README
Mads Kiilerich <madski@unity3d.com>
parents:
4979
diff
changeset
|
30 virtualenv_. Official releases of Kallithea can be installed with:: |
2020 | 31 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4184
diff
changeset
|
32 pip install kallithea |
2020 | 33 |
4902 | 34 The development repository is kept very stable and used in production by the |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
35 developers -- you can do the same. |
2020 | 36 |
4921
24e426cd40ac
README: link to readthedocs.org rather than python.org for documentation
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4913
diff
changeset
|
37 Please visit https://docs.kallithea-scm.org/en/latest/installation.html for |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
38 more details. |
2020 | 39 |
5494
57caeb60c52b
docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents:
5452
diff
changeset
|
40 There is also an experimental `Puppet module`_ for installing and setting up |
57caeb60c52b
docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents:
5452
diff
changeset
|
41 Kallithea. Currently, only basic functionality is provided, but it is still |
57caeb60c52b
docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents:
5452
diff
changeset
|
42 enough to get up and running quickly, especially for people without Python |
57caeb60c52b
docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents:
5452
diff
changeset
|
43 background. See |
57caeb60c52b
docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents:
5452
diff
changeset
|
44 https://docs.kallithea-scm.org/en/latest/installation_puppet.html for further |
57caeb60c52b
docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents:
5452
diff
changeset
|
45 information. |
57caeb60c52b
docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents:
5452
diff
changeset
|
46 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
47 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
48 Source code |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
49 ----------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
50 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
51 The latest sources can be obtained from |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
52 https://kallithea-scm.org/repos/kallithea. |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
53 |
4902 | 54 The issue tracker and a repository mirror can be found at Bitbucket_ on |
55 https://bitbucket.org/conservancy/kallithea. | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
56 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
57 |
5413
22a3fa3c4254
docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents:
5401
diff
changeset
|
58 Kallithea features |
1093 | 59 ------------------ |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
60 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
61 - Has its own middleware to handle Mercurial_ and Git_ protocol requests. Each |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
62 request is authenticated and logged together with IP address. |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
63 - Built for speed and performance. You can make multiple pulls/pushes |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
64 simultaneously. Proven to work with thousands of repositories and users. |
3184 | 65 - Supports http/https, LDAP, AD, proxy-pass authentication. |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
66 - Full permissions (private/read/write/admin) together with IP restrictions for |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
67 each repository, additional explicit forking, repositories group and |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
68 repository creation permissions. |
3848 | 69 - User groups for easier permission management. |
70 - Repository groups let you group repos and manage them easier. They come with | |
71 permission delegation features, so you can delegate groups management. | |
3184 | 72 - Users can fork other users repos, and compare them at any time. |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
73 - Built-in versioned paste functionality (Gist) for sharing code snippets. |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
74 - Integrates easily with other systems, with custom created mappers you can |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
75 connect it to almost any issue tracker, and with a JSON-RPC API you can make |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
76 much more. |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
77 - Built-in commit API lets you add, edit and commit files right from Kallithea |
3184 | 78 web interface using simple editor or upload binary files using simple form. |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
79 - Powerful pull request driven review system with inline commenting, changeset |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
80 statuses, and notification system. |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
81 - Importing and syncing repositories from remote locations for Git_, Mercurial_ |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
82 and Subversion. |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
83 - Mako templates let you customize the look and feel of the application. |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
84 - Beautiful diffs, annotations and source code browsing all colored by |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
85 pygments. Raw diffs are made in Git-diff format for both VCS systems, |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
86 including Git_ binary-patches. |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
87 - Mercurial_ and Git_ DAG graphs and Flot-powered graphs with zooming and |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
88 statistics to track activity for repositories. |
847 | 89 - Admin interface with user/permission management. Admin activity journal, logs |
90 pulls, pushes, forks, registrations and other actions made by all users. | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
91 - Server side forks. It is possible to fork a project and modify it freely |
3184 | 92 without breaking the main repository. |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
93 - reST and Markdown README support for repositories. |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
94 - Full text search powered by Whoosh on the source files, commit messages, and |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
95 file names. Built-in indexing daemons, with optional incremental index build |
4902 | 96 (no external search servers required all in one application). |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
97 - Setup project descriptions/tags and info inside built in DB for easy, |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
98 non-filesystem operations. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
99 - Intelligent cache with invalidation after push or project change, provides |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
100 high performance and always up to date data. |
4902 | 101 - RSS/Atom feeds, Gravatar support, downloadable sources as zip/tar/gz. |
102 - Optional async tasks for speed and performance using Celery_. | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
103 - Backup scripts can do backup of whole app and send it over scp to desired |
4902 | 104 location. |
105 - Based on Pylons, SQLAlchemy, SQLite, Whoosh, vcs. | |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
106 |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
107 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
108 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
109 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
110 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
111 **Kallithea** is released under the GPLv3 license. Kallithea is a `Software |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
112 Freedom Conservancy`_ project and thus controlled by a non-profit organization. |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
113 No commercial entity can take ownership of the project and change the |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
114 direction. |
4902 | 115 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
116 Kallithea started out as an effort to make sure the existing GPLv3 codebase |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
117 would stay available under a legal license. Kallithea thus has to stay GPLv3 |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
118 compatible ... but we are also happy it is GPLv3 and happy to keep it that way. |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
119 A different license (such as AGPL) could perhaps help attract a different |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
120 community with a different mix of Free Software people and companies but we are |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
121 happy with the current focus. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
122 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
123 |
4902 | 124 Community |
125 --------- | |
126 | |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
127 **Kallithea** is maintained by its users who contribute the fixes they would |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
128 like to see. |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
129 |
4902 | 130 Get in touch with the rest of the community: |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
131 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
132 - Join the mailing list users and developers -- see |
4902 | 133 http://lists.sfconservancy.org/mailman/listinfo/kallithea-general. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
134 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
135 - Use IRC and join #kallithea on FreeNode (irc.freenode.net) or use |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
136 http://webchat.freenode.net/?channels=kallithea. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
137 |
4912
295900ff473d
docs: don't use fixed-width fonts when not needed
Andrew Shadura <andrew@shadura.me>
parents:
4902
diff
changeset
|
138 - Follow Kallithea on Twitter, **@KallitheaSCM**. |
2020 | 139 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
140 - Issues can be reported at `issue tracker |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
141 <https://bitbucket.org/conservancy/kallithea/issues>`_. |
2020 | 142 |
4902 | 143 .. note:: |
144 | |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
145 Please try to read the documentation before posting any issues, |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
146 especially the **troubleshooting section** |
2020 | 147 |
796 | 148 |
149 Online documentation | |
150 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
151 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
152 Online documentation for the current version of Kallithea is available at |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
153 https://pythonhosted.org/Kallithea/. Documentation for the current development |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
154 version can be found on https://docs.kallithea-scm.org/. |
2020 | 155 |
4902 | 156 You can also build the documentation locally: go to ``docs/`` and run:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
157 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
158 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
159 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4947
diff
changeset
|
160 .. note:: You need to have Sphinx_ installed to build the |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4947
diff
changeset
|
161 documentation. If you don't have Sphinx_ installed you can |
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4947
diff
changeset
|
162 install it via the command: ``pip install sphinx`` . |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
163 |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
164 |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
165 Converting from RhodeCode |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
166 ------------------------- |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
167 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
168 Currently, you have two options for working with an existing RhodeCode |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
169 database: |
4979
12fb00adc05f
readme: fix invalid rst
Mads Kiilerich <madski@unity3d.com>
parents:
4955
diff
changeset
|
170 |
12fb00adc05f
readme: fix invalid rst
Mads Kiilerich <madski@unity3d.com>
parents:
4955
diff
changeset
|
171 - keep the database unconverted (intended for testing and evaluation) |
12fb00adc05f
readme: fix invalid rst
Mads Kiilerich <madski@unity3d.com>
parents:
4955
diff
changeset
|
172 - convert the database in a one-time step |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
173 |
5413
22a3fa3c4254
docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents:
5401
diff
changeset
|
174 Maintaining interoperability |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5502
diff
changeset
|
175 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
176 |
4902 | 177 Interoperability with RhodeCode 2.2.X installations is provided so you don't |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
178 have to immediately commit to switching to Kallithea. This option will most |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
179 likely go away once the two projects have diverged significantly. |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
180 |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
181 To run Kallithea on a RhodeCode database, run:: |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
182 |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
183 echo "BRAND = 'rhodecode'" > kallithea/brand.py |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
184 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
185 This location will depend on where you installed Kallithea. If you installed |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
186 via:: |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
187 |
5502
ae9ab4c92d46
setup: explicitly use python2 in examples in the documentation
Mads Kiilerich <madski@unity3d.com>
parents:
5494
diff
changeset
|
188 python2 setup.py install |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
189 |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
190 then you will find this location at |
4902 | 191 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``. |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
192 |
5413
22a3fa3c4254
docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents:
5401
diff
changeset
|
193 One-time conversion |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5502
diff
changeset
|
194 ^^^^^^^^^^^^^^^^^^^ |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
195 |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
196 Alternatively, if you would like to convert the database for good, you can use |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
197 a helper script provided by Kallithea. This script will operate directly on the |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
198 database, using the database string you can find in your ``production.ini`` (or |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
199 ``development.ini``) file. For example, if using SQLite:: |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
200 |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
201 cd /path/to/kallithea |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
202 cp /path/to/rhodecode/rhodecode.db kallithea.db |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
203 pip install sqlalchemy-migrate |
5502
ae9ab4c92d46
setup: explicitly use python2 in examples in the documentation
Mads Kiilerich <madski@unity3d.com>
parents:
5494
diff
changeset
|
204 python2 kallithea/bin/rebranddb.py sqlite:///kallithea.db |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
205 |
4902 | 206 .. Note:: |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
207 |
4902 | 208 If you started out using the branding interoperability approach mentioned |
209 above, watch out for stray brand.pyc after removing brand.py. | |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
210 |
5452
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
211 Git hooks |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5502
diff
changeset
|
212 ^^^^^^^^^ |
5452
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
213 |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
214 After switching to Kallithea, it will be necessary to update the Git_ hooks in |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
215 your repositories. If not, the Git_ hooks from RhodeCode will still be called, |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
216 which will cause ``git push`` to fail every time. |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
217 |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
218 If you do not have any custom Git_ hooks deployed, perform the following steps |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
219 (this may take some time depending on the number and size of repositories you |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
220 have): |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
221 |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
222 1. Log-in as an administrator. |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
223 |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
224 2. Open page *Admin > Settings > Remap and Rescan*. |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
225 |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
226 3. Turn on the option **Install Git Hooks**. |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
227 |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
228 4. Turn on the option **Overwrite existing Git hooks**. |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
229 |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
230 5. Click on the button **Rescan Repositories**. |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
231 |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
232 If you do have custom hooks, you will need to merge those changes manually. In |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
233 order to get sample hooks from Kallithea, the easiest way is to create a new Git_ |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
234 repository, and have a look at the hooks deployed there. |
c3d83238afa1
git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents:
5433
diff
changeset
|
235 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
236 |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
237 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
238 .. _Python: http://www.python.org/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
239 .. _Sphinx: http://sphinx.pocoo.org/ |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
240 .. _Mercurial: http://mercurial.selenic.com/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
241 .. _Bitbucket: http://bitbucket.org/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
242 .. _GitHub: http://github.com/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
243 .. _Subversion: http://subversion.tigris.org/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
244 .. _Git: http://git-scm.com/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
245 .. _Celery: http://celeryproject.org/ |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
246 .. _vcs: http://pypi.python.org/pypi/vcs |
4902 | 247 .. _Software Freedom Conservancy: http://sfconservancy.org/ |
5494
57caeb60c52b
docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents:
5452
diff
changeset
|
248 .. _Puppet module: https://forge.puppetlabs.com/rauch/kallithea |