Mercurial > kallithea

comparison README.rst @ 3224:8b8edfc25856 beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
whitespace cleanup
author Marcin Kuzminski <marcin@python-works.com>
date Fri, 25 Jan 2013 02:31:17 +0100
parents 6180e031a2b9
children d09c037df514
comparison
equal deleted inserted replaced
3223:74e455c06881 3224:8b8edfc25856
3 ========= 3 =========
4 4
5 About 5 About
6 ----- 6 -----
7 7
8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ 8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
9 with a built in push/pull server and full text search and code-review. 9 with a built in push/pull server and full text search and code-review.
10 It works on http/https and has a built in permission/authentication system with 10 It works on http/https and has a built in permission/authentication system with
11 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides 11 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides
12 simple API so it's easy integrable with existing external systems. 12 simple API so it's easy integrable with existing external systems.
13 13
14 RhodeCode is similar in some respects to github_ or bitbucket_, 14 RhodeCode is similar in some respects to github_ or bitbucket_,
15 however RhodeCode can be run as standalone hosted application on your own server. 15 however RhodeCode can be run as standalone hosted application on your own server.
16 It is open source and donation ware and focuses more on providing a customized, 16 It is open source and donation ware and focuses more on providing a customized,
17 self administered interface for Mercurial_ and GIT_ repositories. 17 self administered interface for Mercurial_ and GIT_ repositories.
18 RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library 18 RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library
19 that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple 19 that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple
20 different version control systems. 20 different version control systems.
21 21
22 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_ 22 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
23 23
24 Installation 24 Installation
27 27
28 easy_install rhodecode 28 easy_install rhodecode
29 29
30 Or:: 30 Or::
31 31
32 pip install rhodecode 32 pip install rhodecode
33 33
34 Detailed instructions and links may be found on the Installation page. 34 Detailed instructions and links may be found on the Installation page.
35 35
36 Please visit http://packages.python.org/RhodeCode/installation.html for 36 Please visit http://packages.python.org/RhodeCode/installation.html for
37 more details 37 more details
49 49
50 Source code 50 Source code
51 ----------- 51 -----------
52 52
53 The latest sources can be obtained from official RhodeCode instance 53 The latest sources can be obtained from official RhodeCode instance
54 https://secure.rhodecode.org 54 https://secure.rhodecode.org
55 55
56 56
57 MIRRORS: 57 MIRRORS:
58 58
59 Issue tracker and sources at bitbucket_ 59 Issue tracker and sources at bitbucket_
66 66
67 67
68 RhodeCode Features 68 RhodeCode Features
69 ------------------ 69 ------------------
70 70
71 - Has its own middleware to handle mercurial_ and git_ protocol requests. 71 - Has its own middleware to handle mercurial_ and git_ protocol requests.
72 Each request is authenticated and logged together with IP address. 72 Each request is authenticated and logged together with IP address.
73 - Build for speed and performance. You can make multiple pulls/pushes simultaneous. 73 - Build for speed and performance. You can make multiple pulls/pushes simultaneous.
74 Proven to work with 1000s of repositories and users 74 Proven to work with 1000s of repositories and users
75 - Supports http/https, LDAP, AD, proxy-pass authentication. 75 - Supports http/https, LDAP, AD, proxy-pass authentication.
76 - Full permissions (private/read/write/admin) together with IP restrictions for each repository, 76 - Full permissions (private/read/write/admin) together with IP restrictions for each repository,
84 web interface using simple editor or upload binary files using simple form. 84 web interface using simple editor or upload binary files using simple form.
85 - Powerfull pull-request driven review system with inline commenting, 85 - Powerfull pull-request driven review system with inline commenting,
86 changeset statuses, and notification system. 86 changeset statuses, and notification system.
87 - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN. 87 - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN.
88 - Mako templates let's you customize the look and feel of the application. 88 - Mako templates let's you customize the look and feel of the application.
89 - Beautiful diffs, annotations and source code browsing all colored by pygments. 89 - Beautiful diffs, annotations and source code browsing all colored by pygments.
90 Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches 90 Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches
91 - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics 91 - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics
92 to track activity for repositories 92 to track activity for repositories
93 - Admin interface with user/permission management. Admin activity journal, logs 93 - Admin interface with user/permission management. Admin activity journal, logs
94 pulls, pushes, forks, registrations and other actions made by all users. 94 pulls, pushes, forks, registrations and other actions made by all users.
95 - Server side forks. It is possible to fork a project and modify it freely 95 - Server side forks. It is possible to fork a project and modify it freely
96 without breaking the main repository. 96 without breaking the main repository.
97 - rst and markdown README support for repositories. 97 - rst and markdown README support for repositories.
98 - Full text search powered by Whoosh on the source files, commit messages, and file names. 98 - Full text search powered by Whoosh on the source files, commit messages, and file names.
99 Build in indexing daemons, with optional incremental index build 99 Build in indexing daemons, with optional incremental index build
100 (no external search servers required all in one application) 100 (no external search servers required all in one application)
101 - Setup project descriptions/tags and info inside built in db for easy, non 101 - Setup project descriptions/tags and info inside built in db for easy, non
102 file-system operations. 102 file-system operations.
103 - Intelligent cache with invalidation after push or project change, provides 103 - Intelligent cache with invalidation after push or project change, provides
104 high performance and always up to date data. 104 high performance and always up to date data.
105 - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz 105 - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz
106 - Optional async tasks for speed and performance using celery_ 106 - Optional async tasks for speed and performance using celery_
107 - Backup scripts can do backup of whole app and send it over scp to desired 107 - Backup scripts can do backup of whole app and send it over scp to desired
108 location 108 location
109 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs 109 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
110 110
111 111
112 Incoming / Plans 112 Incoming / Plans
113 ---------------- 113 ----------------
114 114
115 - Finer granular permissions per branch, or subrepo 115 - Finer granular permissions per branch, or subrepo
116 - Web based merges for pull requests 116 - Web based merges for pull requests
117 - Tracking history for each lines in files 117 - Tracking history for each lines in files
118 - Simple issue tracker 118 - Simple issue tracker
119 - SSH based authentication with server side key management 119 - SSH based authentication with server side key management
120 - Commit based built in wiki system 120 - Commit based built in wiki system
121 - Gist server 121 - Gist server
122 - More statistics and graph (global annotation + some more statistics) 122 - More statistics and graph (global annotation + some more statistics)
123 - Other advancements as development continues (or you can of course make 123 - Other advancements as development continues (or you can of course make
124 additions and or requests) 124 additions and or requests)
125 125
126 License 126 License
127 ------- 127 -------
128 128
133 ------------ 133 ------------
134 134
135 Listed bellow are various support resources that should help. 135 Listed bellow are various support resources that should help.
136 136
137 .. note:: 137 .. note::
138 138
139 Please try to read the documentation before posting any issues, especially 139 Please try to read the documentation before posting any issues, especially
140 the **troubleshooting section** 140 the **troubleshooting section**
141 141
142 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask 142 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask
143 any questions. 143 any questions.
144 144
145 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ 145 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
146 146
161 You may also build the documentation for yourself - go into ``docs/`` and run:: 161 You may also build the documentation for yourself - go into ``docs/`` and run::
162 162
163 make html 163 make html
164 164
165 (You need to have sphinx_ installed to build the documentation. If you don't 165 (You need to have sphinx_ installed to build the documentation. If you don't
166 have sphinx_ installed you can install it via the command: 166 have sphinx_ installed you can install it via the command:
167 ``easy_install sphinx``) 167 ``easy_install sphinx``)
168 168
169 .. _virtualenv: http://pypi.python.org/pypi/virtualenv 169 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
170 .. _python: http://www.python.org/ 170 .. _python: http://www.python.org/
171 .. _sphinx: http://sphinx.pocoo.org/ 171 .. _sphinx: http://sphinx.pocoo.org/
172 .. _mercurial: http://mercurial.selenic.com/ 172 .. _mercurial: http://mercurial.selenic.com/
173 .. _bitbucket: http://bitbucket.org/ 173 .. _bitbucket: http://bitbucket.org/