Mercurial > kallithea
annotate README.rst @ 4180:08af8038e1cc kallithea-2.2.5-rebrand
Change IRC channel and Twitter account; remove google group
author | Bradley M. Kuhn <bkuhn@sfconservancy.org> |
---|---|
date | Wed, 02 Jul 2014 19:03:47 -0400 |
parents | 010e9532801a |
children | 48ad84558fb4 |
rev | line source |
---|---|
2020 | 1 ========= |
2 RhodeCode | |
3 ========= | |
4 | |
5 About | |
6 ----- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
7 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
8 ``RhodeCode`` 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 |
1982
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
1839
diff
changeset
|
11 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides |
1750 | 12 simple API so it's easy integrable with existing external systems. |
1093 | 13 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
14 RhodeCode is similar in some respects to github_ or bitbucket_, |
1750 | 15 however RhodeCode 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. |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
18 RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library |
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 |
2167 | 22 RhodeCode 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 ------------ | |
26 Stable releases of RhodeCode are best installed via:: | |
27 | |
28 easy_install rhodecode | |
29 | |
30 Or:: | |
31 | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
32 pip install rhodecode |
2020 | 33 |
34 Detailed instructions and links may be found on the Installation page. | |
35 | |
36 Please visit http://packages.python.org/RhodeCode/installation.html for | |
37 more details | |
38 | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
39 RhodeCode demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
40 -------------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
41 |
1127 | 42 http://demo.rhodecode.org |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
43 |
1093 | 44 The default access is anonymous but you can login to an administrative account |
45 using the following credentials: | |
254 | 46 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
47 - username: demo |
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
48 - password: demo12 |
572
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 Source code |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
51 ----------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
52 |
4179
010e9532801a
Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3960
diff
changeset
|
53 The latest sources can be obtained from https://kallithea-scm.org/repos/kallithea |
254 | 54 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
55 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
56 MIRRORS: |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
57 |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
58 Issue tracker and sources at bitbucket_ |
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
59 |
4179
010e9532801a
Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3960
diff
changeset
|
60 https://bitbucket.org/conservancy/kallithea |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
61 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
62 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
63 |
1093 | 64 RhodeCode Features |
65 ------------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
66 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
67 - Has its own middleware to handle mercurial_ and git_ protocol requests. |
3184 | 68 Each request is authenticated and logged together with IP address. |
69 - Build for speed and performance. You can make multiple pulls/pushes simultaneous. | |
70 Proven to work with 1000s of repositories and users | |
71 - Supports http/https, LDAP, AD, proxy-pass authentication. | |
72 - Full permissions (private/read/write/admin) together with IP restrictions for each repository, | |
3848 | 73 additional explicit forking, repositories group and repository creation permissions. |
74 - User groups for easier permission management. | |
75 - Repository groups let you group repos and manage them easier. They come with | |
76 permission delegation features, so you can delegate groups management. | |
3184 | 77 - Users can fork other users repos, and compare them at any time. |
3848 | 78 - Built in Gist functionality for sharing code snippets. |
3184 | 79 - Integrates easily with other systems, with custom created mappers you can connect it to almost |
80 any issue tracker, and with an JSON-RPC API you can make much more | |
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
81 - Build in commit-api let's you add, edit and commit files right from RhodeCode |
3184 | 82 web interface using simple editor or upload binary files using simple form. |
83 - Powerfull pull-request driven review system with inline commenting, | |
84 changeset statuses, and notification system. | |
85 - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN. | |
1093 | 86 - 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
|
87 - Beautiful diffs, annotations and source code browsing all colored by pygments. |
3184 | 88 Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches |
89 - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics | |
90 to track activity for repositories | |
847 | 91 - Admin interface with user/permission management. Admin activity journal, logs |
92 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
|
93 - Server side forks. It is possible to fork a project and modify it freely |
3184 | 94 without breaking the main repository. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
95 - rst and markdown README support for repositories. |
3184 | 96 - Full text search powered by Whoosh on the source files, commit messages, and file names. |
847 | 97 Build in indexing daemons, with optional incremental index build |
1093 | 98 (no external search servers required all in one application) |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
99 - Setup project descriptions/tags and info inside built in db for easy, non |
3184 | 100 file-system operations. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
101 - 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
|
102 high performance and always up to date data. |
3184 | 103 - 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
|
104 - Optional async tasks for speed and performance using celery_ |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
105 - 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
|
106 location |
847 | 107 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs |
0 | 108 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
109 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
110 Incoming / Plans |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
111 ---------------- |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
112 |
3184 | 113 - Finer granular permissions per branch, or subrepo |
114 - Web based merges for pull requests | |
115 - Tracking history for each lines in files | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
116 - Simple issue tracker |
1093 | 117 - SSH based authentication with server side key management |
118 - Commit based built in wiki system | |
119 - More statistics and graph (global annotation + some more statistics) | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
120 - 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
|
121 additions and or requests) |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
122 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
123 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
124 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
125 |
1206
a671db5bdd58
fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents:
1167
diff
changeset
|
126 ``RhodeCode`` is released under the GPLv3 license. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
127 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
128 |
2020 | 129 Getting help |
130 ------------ | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
131 |
2020 | 132 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
|
133 |
2020 | 134 .. note:: |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
135 |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
2266
diff
changeset
|
136 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
|
137 the **troubleshooting section** |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
138 |
4179
010e9532801a
Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3960
diff
changeset
|
139 - Open an issue at `issue tracker <https://bitbucket.org/conservancy/kallithea/issues>`_ |
2020 | 140 |
4180
08af8038e1cc
Change IRC channel and Twitter account; remove google group
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4179
diff
changeset
|
141 - 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
|
142 or use http://webchat.freenode.net/?channels=kallithea for web access to irc. |
2020 | 143 |
4180
08af8038e1cc
Change IRC channel and Twitter account; remove google group
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4179
diff
changeset
|
144 You can follow this project on Twitter, **@KallitheaSCM**. |
2020 | 145 |
796 | 146 |
147 Online documentation | |
148 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
149 |
1093 | 150 Online documentation for the current version of RhodeCode is available at |
2020 | 151 - http://packages.python.org/RhodeCode/ |
152 - http://rhodecode.readthedocs.org/en/latest/index.html | |
153 | |
1093 | 154 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
|
155 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
156 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
157 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
158 (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
|
159 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
|
160 ``easy_install sphinx``) |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
161 |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
162 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
163 .. _python: http://www.python.org/ |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
164 .. _sphinx: http://sphinx.pocoo.org/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
165 .. _mercurial: http://mercurial.selenic.com/ |
1123 | 166 .. _bitbucket: http://bitbucket.org/ |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
167 .. _github: http://github.com/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
168 .. _subversion: http://subversion.tigris.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
169 .. _git: http://git-scm.com/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
170 .. _celery: http://celeryproject.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
171 .. _Sphinx: http://sphinx.pocoo.org/ |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
172 .. _vcs: http://pypi.python.org/pypi/vcs |