Mercurial > kallithea
annotate README.rst @ 4219:24498ba2fbec kallithea-2.2.5-rebrand
SETTINGS_PREFIX for identifiers (e.g., db table names) incl. project's name.
kallithea.SETTINGS_PREFIX is a variable string used as a prefix for specific
external identifiers, such as database table names (and likely later form
fields), so that the name of the project need not necessarily be encoded into
data.
This setting is configurable so that compatibility with old, similar
databases can be maintained at the users' request.
author | Bradley M. Kuhn <bkuhn@sfconservancy.org> |
---|---|
date | Fri, 23 May 2014 17:36:09 -0400 |
parents | 24c0d584ba86 |
children | 6de8a139ab07 |
rev | line source |
---|---|
2020 | 1 ========= |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
2 Kallithea |
2020 | 3 ========= |
4 | |
5 About | |
6 ----- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
7 |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
8 ``Kallithea`` is a fast and powerful management tool for Mercurial_ and GIT_ |
3306
d09c037df514
Fixed README spelling
Marcin Kuzminski <marcin@python-works.com>
parents:
3224
diff
changeset
|
9 with a built in push/pull server, full text search and code-review. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
10 It works on http/https and has a built in permission/authentication system with |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
11 the ability to authenticate via LDAP or ActiveDirectory. Kallithea also provides |
1750 | 12 simple API so it's easy integrable with existing external systems. |
1093 | 13 |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
14 Kallithea is similar in some respects to github_ or bitbucket_, |
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
15 however Kallithea can be run as standalone hosted application on your own server. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
16 It is open source and donation ware and focuses more on providing a customized, |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
17 self administered interface for Mercurial_ and GIT_ repositories. |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
18 Kallithea works on \*nix systems and Windows it is powered by a vcs_ library |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
19 that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple |
2117
d743568f2f57
readme update, write rhodecode works on windows !
Marcin Kuzminski <marcin@python-works.com>
parents:
2034
diff
changeset
|
20 different version control systems. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
21 |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
22 Kallithea uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_ |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
23 |
2020 | 24 Installation |
25 ------------ | |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
26 Stable releases of Kallithea are best installed via:: |
2020 | 27 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4184
diff
changeset
|
28 easy_install kallithea |
2020 | 29 |
30 Or:: | |
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 |
34 Detailed instructions and links may be found on the Installation page. | |
35 | |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4184
diff
changeset
|
36 Please visit http://packages.python.org/Kallithea/installation.html for |
2020 | 37 more details |
38 | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
39 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
40 Source code |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
41 ----------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
42 |
4179
010e9532801a
Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3960
diff
changeset
|
43 The latest sources can be obtained from https://kallithea-scm.org/repos/kallithea |
254 | 44 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
45 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
46 MIRRORS: |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
47 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
48 Issue tracker and sources at bitbucket_ |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
49 |
4179
010e9532801a
Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3960
diff
changeset
|
50 https://bitbucket.org/conservancy/kallithea |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
51 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
52 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
53 |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
54 Kallithea Features |
1093 | 55 ------------------ |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
56 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
57 - Has its own middleware to handle mercurial_ and git_ protocol requests. |
3184 | 58 Each request is authenticated and logged together with IP address. |
59 - Build for speed and performance. You can make multiple pulls/pushes simultaneous. | |
60 Proven to work with 1000s of repositories and users | |
61 - Supports http/https, LDAP, AD, proxy-pass authentication. | |
62 - Full permissions (private/read/write/admin) together with IP restrictions for each repository, | |
3848 | 63 additional explicit forking, repositories group and repository creation permissions. |
64 - User groups for easier permission management. | |
65 - Repository groups let you group repos and manage them easier. They come with | |
66 permission delegation features, so you can delegate groups management. | |
3184 | 67 - Users can fork other users repos, and compare them at any time. |
3848 | 68 - Built in Gist functionality for sharing code snippets. |
3184 | 69 - Integrates easily with other systems, with custom created mappers you can connect it to almost |
70 any issue tracker, and with an JSON-RPC API you can make much more | |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
71 - Build in commit-api let's you add, edit and commit files right from Kallithea |
3184 | 72 web interface using simple editor or upload binary files using simple form. |
73 - Powerfull pull-request driven review system with inline commenting, | |
74 changeset statuses, and notification system. | |
75 - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN. | |
1093 | 76 - Mako templates let's you customize the look and feel of the application. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
77 - Beautiful diffs, annotations and source code browsing all colored by pygments. |
3184 | 78 Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches |
79 - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics | |
80 to track activity for repositories | |
847 | 81 - Admin interface with user/permission management. Admin activity journal, logs |
82 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
|
83 - Server side forks. It is possible to fork a project and modify it freely |
3184 | 84 without breaking the main repository. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
85 - rst and markdown README support for repositories. |
3184 | 86 - Full text search powered by Whoosh on the source files, commit messages, and file names. |
847 | 87 Build in indexing daemons, with optional incremental index build |
1093 | 88 (no external search servers required all in one application) |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
89 - Setup project descriptions/tags and info inside built in db for easy, non |
3184 | 90 file-system operations. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
91 - 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
|
92 high performance and always up to date data. |
3184 | 93 - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
94 - Optional async tasks for speed and performance using celery_ |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
95 - Backup scripts can do backup of whole app and send it over scp to desired |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
96 location |
847 | 97 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs |
0 | 98 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
99 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
100 Incoming / Plans |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
101 ---------------- |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
102 |
3184 | 103 - Finer granular permissions per branch, or subrepo |
104 - Web based merges for pull requests | |
105 - Tracking history for each lines in files | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
106 - Simple issue tracker |
1093 | 107 - SSH based authentication with server side key management |
108 - Commit based built in wiki system | |
109 - More statistics and graph (global annotation + some more statistics) | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
110 - Other advancements as development continues (or you can of course make |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
111 additions and or requests) |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
112 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
113 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
114 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
115 |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
116 ``Kallithea`` is released under the GPLv3 license. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
117 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
118 |
2020 | 119 Getting help |
120 ------------ | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
121 |
2020 | 122 Listed bellow are various support resources that should help. |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
123 |
2020 | 124 .. note:: |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
125 |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
2266
diff
changeset
|
126 Please try to read the documentation before posting any issues, especially |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
2266
diff
changeset
|
127 the **troubleshooting section** |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
128 |
4179
010e9532801a
Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3960
diff
changeset
|
129 - Open an issue at `issue tracker <https://bitbucket.org/conservancy/kallithea/issues>`_ |
2020 | 130 |
4180
08af8038e1cc
Change IRC channel and Twitter account; remove google group
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4179
diff
changeset
|
131 - Join #kallithea on FreeNode (irc.freenode.net) |
08af8038e1cc
Change IRC channel and Twitter account; remove google group
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4179
diff
changeset
|
132 or use http://webchat.freenode.net/?channels=kallithea for web access to irc. |
2020 | 133 |
4180
08af8038e1cc
Change IRC channel and Twitter account; remove google group
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4179
diff
changeset
|
134 You can follow this project on Twitter, **@KallitheaSCM**. |
2020 | 135 |
796 | 136 |
137 Online documentation | |
138 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
139 |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
140 Online documentation for the current version of Kallithea is available at |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4184
diff
changeset
|
141 - http://packages.python.org/Kallithea/ |
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4184
diff
changeset
|
142 - http://kallithea.readthedocs.org/ |
2020 | 143 |
1093 | 144 You may also build the documentation for yourself - go into ``docs/`` and run:: |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
145 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
146 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
147 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
148 (You need to have sphinx_ installed to build the documentation. If you don't |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
149 have sphinx_ installed you can install it via the command: |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
150 ``easy_install sphinx``) |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
151 |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
152 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
153 .. _python: http://www.python.org/ |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
154 .. _sphinx: http://sphinx.pocoo.org/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
155 .. _mercurial: http://mercurial.selenic.com/ |
1123 | 156 .. _bitbucket: http://bitbucket.org/ |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
157 .. _github: http://github.com/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
158 .. _subversion: http://subversion.tigris.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
159 .. _git: http://git-scm.com/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
160 .. _celery: http://celeryproject.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
161 .. _Sphinx: http://sphinx.pocoo.org/ |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
162 .. _vcs: http://pypi.python.org/pypi/vcs |