Mercurial > kallithea
annotate README.rst @ 3043:b61824e61e68 beta
Don't cache dulwich Repos, in pararell multithreaded evniroment dulwich pack file openers
can break badly. We need to create Repo() objects always for each call, even when it's
taken from cache.
Fixed issue with dulwich filedescriptor leak ref #573
| author | Marcin Kuzminski <marcin@python-works.com> |
|---|---|
| date | Thu, 29 Nov 2012 19:29:33 +0100 |
| parents | 5d12768a0aa1 |
| children | 63e58ef80ef1 6180e031a2b9 |
| 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 |
| 1750 | 8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ |
|
1982
87f0800abc7b
#227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents:
1839
diff
changeset
|
9 with a built in push/pull server and full text search and code-review. |
| 1093 | 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 |
| 2034 | 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. |
| 1093 | 16 It is open source and donation ware and focuses more on providing a customized, |
| 2034 | 17 self administered interface for Mercurial_ and GIT_ repositories. |
|
2266
64ef1b886336
fix * rendering in README file
Marcin Kuzminski <marcin@python-works.com>
parents:
2167
diff
changeset
|
18 RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library |
|
2117
d743568f2f57
readme update, write rhodecode works on windows !
Marcin Kuzminski <marcin@python-works.com>
parents:
2034
diff
changeset
|
19 that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple |
|
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 | |
| 32 pip install rhodecode | |
| 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 |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
53 The latest sources can be obtained from official RhodeCode instance |
|
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
54 https://secure.rhodecode.org |
| 254 | 55 |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
56 |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
57 MIRRORS: |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
58 |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
59 Issue tracker and sources at bitbucket_ |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
60 |
| 847 | 61 http://bitbucket.org/marcinkuzminski/rhodecode |
|
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
62 |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
63 Sources at github_ |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
64 |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
65 https://github.com/marcinkuzminski/rhodecode |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
66 |
|
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
67 |
| 1093 | 68 RhodeCode Features |
| 69 ------------------ | |
|
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
70 |
| 1663 | 71 - Has its own middleware to handle mercurial_ protocol requests. |
| 1093 | 72 Each request can be logged and authenticated. |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
73 - Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous. |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
74 Supports http/https and LDAP |
|
2775
5d12768a0aa1
docs improvements
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
75 - Full permissions (private/read/write/admin) for each repository, additional |
|
5d12768a0aa1
docs improvements
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
76 explicit forking and repository permissions. |
|
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
869
diff
changeset
|
77 - Have built in users groups for easier permission management |
| 1405 | 78 - Repository groups let you group repos and manage them easier. |
|
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
869
diff
changeset
|
79 - Users can fork other users repo. RhodeCode have also compare view to see |
|
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
869
diff
changeset
|
80 combined changeset for all changeset made within single push. |
|
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 |
|
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
82 interface using simple editor or upload form for binaries. |
|
2775
5d12768a0aa1
docs improvements
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
83 - Powerfull pull-request driven review system with inline commenting, and |
|
5d12768a0aa1
docs improvements
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
84 changeset statuses, notification system. |
|
5d12768a0aa1
docs improvements
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
85 - Importing SVN repositories from remote locations into RhodeCode. |
| 1093 | 86 - Mako templates let's you customize the look and feel of the application. |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
87 - Beautiful diffs, annotations and source code browsing all colored by pygments. |
|
2775
5d12768a0aa1
docs improvements
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
88 Raw diffs are made in git-diff format, including GIT_ binary-patches |
|
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
89 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
| 847 | 90 - Admin interface with user/permission management. Admin activity journal, logs |
| 91 pulls, pushes, forks, registrations and other actions made by all users. | |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
92 - Server side forks. It is possible to fork a project and modify it freely |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
93 without breaking the main repository. You can even write Your own hooks |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
94 and install them |
| 1750 | 95 - rst and markdown README support for repositories |
| 1093 | 96 - Full text search powered by Whoosh on the source files, 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) |
| 847 | 99 - Setup project descriptions and info inside built in db for easy, non |
| 100 file-system operations | |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
101 - Intelligent cache with invalidation after push or project change, provides |
|
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. |
| 847 | 103 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz |
| 2146 | 104 - Optional async tasks for speed and performance using celery_ |
|
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
105 - Backup scripts can do backup of whole app and send it over scp to desired |
| 847 | 106 location |
| 107 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs | |
| 0 | 108 |
| 796 | 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 |
|
1488
dc16211e7292
Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents:
1405
diff
changeset
|
113 - Finer granular permissions per branch, repo group or subrepo |
|
2775
5d12768a0aa1
docs improvements
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
114 - Pull requests with web based merges |
|
5d12768a0aa1
docs improvements
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
115 - Per line file history |
|
5d12768a0aa1
docs improvements
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
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) | |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
120 - Other advancements as development continues (or you can of course make |
|
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:: |
| 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** |
| 2020 | 138 |
| 139 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask | |
| 140 any questions. | |
|
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
141 |
| 2020 | 142 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ |
| 143 | |
| 144 | |
| 145 - Join #rhodecode on FreeNode (irc.freenode.net) | |
| 146 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. | |
| 147 | |
| 2034 | 148 - You can also follow me on twitter **@marcinkuzminski** where i often post some |
| 2020 | 149 news about RhodeCode |
| 150 | |
| 796 | 151 |
| 152 Online documentation | |
| 153 -------------------- | |
|
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
154 |
| 1093 | 155 Online documentation for the current version of RhodeCode is available at |
| 2020 | 156 - http://packages.python.org/RhodeCode/ |
| 157 - http://rhodecode.readthedocs.org/en/latest/index.html | |
| 158 | |
| 1093 | 159 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
|
160 |
|
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
161 make html |
|
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
162 |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
163 (You need to have sphinx_ installed to build the documentation. If you don't |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
164 have sphinx_ installed you can install it via the command: |
|
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
165 ``easy_install sphinx``) |
| 1093 | 166 |
|
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
167 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
168 .. _python: http://www.python.org/ |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
169 .. _sphinx: http://sphinx.pocoo.org/ |
|
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
170 .. _mercurial: http://mercurial.selenic.com/ |
| 1123 | 171 .. _bitbucket: http://bitbucket.org/ |
|
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
172 .. _github: http://github.com/ |
|
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
173 .. _subversion: http://subversion.tigris.org/ |
|
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
174 .. _git: http://git-scm.com/ |
|
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
175 .. _celery: http://celeryproject.org/ |
|
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
176 .. _Sphinx: http://sphinx.pocoo.org/ |
|
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
177 .. _vcs: http://pypi.python.org/pypi/vcs |