Show More
@@ -1,180 +1,102 b'' | |||
|
1 | 1 | ========= |
|
2 | 2 | RhodeCode |
|
3 | 3 | ========= |
|
4 | 4 | |
|
5 | 5 | About |
|
6 | 6 | ----- |
|
7 | 7 | |
|
8 | 8 | ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ |
|
9 | 9 | with a built in push/pull server, full text search and code-review. |
|
10 | 10 | It works on http/https and has a built in permission/authentication system with |
|
11 | 11 | the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides |
|
12 | 12 | simple API so it's easy integrable with existing external systems. |
|
13 | 13 | |
|
14 | 14 | RhodeCode is similar in some respects to github_ or bitbucket_, |
|
15 | 15 | however RhodeCode can be run as standalone hosted application on your own server. |
|
16 | 16 | It is open source and donation ware and focuses more on providing a customized, |
|
17 | 17 | self administered interface for Mercurial_ and GIT_ repositories. |
|
18 | 18 | RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library |
|
19 | 19 | that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple |
|
20 | 20 | different version control systems. |
|
21 | 21 | |
|
22 | 22 | RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_ |
|
23 | 23 | |
|
24 | 24 | Installation |
|
25 | 25 | ------------ |
|
26 | 26 | Stable releases of RhodeCode are best installed via:: |
|
27 | 27 | |
|
28 | easy_install rhodecode | |
|
29 | ||
|
30 | Or:: | |
|
31 | ||
|
32 | pip install rhodecode | |
|
28 | pip install https://rhodecode.com/dl/latest | |
|
33 | 29 | |
|
34 | 30 | Detailed instructions and links may be found on the Installation page. |
|
35 | 31 | |
|
36 |
Please visit http:// |
|
|
37 | more details | |
|
38 | ||
|
39 | RhodeCode demo | |
|
40 | -------------- | |
|
32 | Please visit https://rhodecode.com/docs/installation.html for more details | |
|
41 | 33 | |
|
42 | http://demo.rhodecode.org | |
|
43 | ||
|
44 | The default access is anonymous but you can login to an administrative account | |
|
45 | using the following credentials: | |
|
46 | ||
|
47 | - username: demo | |
|
48 | - password: demo12 | |
|
49 | 34 | |
|
50 | 35 | Source code |
|
51 | 36 | ----------- |
|
52 | 37 | |
|
53 | 38 | The latest sources can be obtained from official RhodeCode instance |
|
54 | 39 | https://secure.rhodecode.org |
|
55 | 40 | |
|
56 | 41 | |
|
57 | MIRRORS: | |
|
58 | ||
|
59 | Issue tracker and sources at bitbucket_ | |
|
60 | ||
|
61 | http://bitbucket.org/marcinkuzminski/rhodecode | |
|
62 | ||
|
63 | Sources at github_ | |
|
64 | ||
|
65 | https://github.com/marcinkuzminski/rhodecode | |
|
66 | ||
|
67 | ||
|
68 | 42 | RhodeCode Features |
|
69 | 43 | ------------------ |
|
70 | 44 | |
|
71 | - Has its own middleware to handle mercurial_ and git_ protocol requests. | |
|
72 | Each request is authenticated and logged together with IP address. | |
|
73 | - Build for speed and performance. You can make multiple pulls/pushes simultaneous. | |
|
74 | Proven to work with 1000s of repositories and users | |
|
75 | - Supports http/https, LDAP, AD, proxy-pass authentication. | |
|
76 | - Full permissions (private/read/write/admin) together with IP restrictions for each repository, | |
|
77 | additional explicit forking, repositories group and repository creation permissions. | |
|
78 | - User groups for easier permission management. | |
|
79 | - Repository groups let you group repos and manage them easier. They come with | |
|
80 | permission delegation features, so you can delegate groups management. | |
|
81 | - Users can fork other users repos, and compare them at any time. | |
|
82 | - Built in Gist functionality for sharing code snippets. | |
|
83 | - Integrates easily with other systems, with custom created mappers you can connect it to almost | |
|
84 | any issue tracker, and with an JSON-RPC API you can make much more | |
|
85 | - Build in commit-api let's you add, edit and commit files right from RhodeCode | |
|
86 | web interface using simple editor or upload binary files using simple form. | |
|
87 | - Powerfull pull-request driven review system with inline commenting, | |
|
88 | changeset statuses, and notification system. | |
|
89 | - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN. | |
|
90 | - Mako templates let's you customize the look and feel of the application. | |
|
91 | - Beautiful diffs, annotations and source code browsing all colored by pygments. | |
|
92 | Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches | |
|
93 | - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics | |
|
94 | to track activity for repositories | |
|
95 | - Admin interface with user/permission management. Admin activity journal, logs | |
|
96 | pulls, pushes, forks, registrations and other actions made by all users. | |
|
97 | - Server side forks. It is possible to fork a project and modify it freely | |
|
98 | without breaking the main repository. | |
|
99 | - rst and markdown README support for repositories. | |
|
100 | - Full text search powered by Whoosh on the source files, commit messages, and file names. | |
|
101 | Build in indexing daemons, with optional incremental index build | |
|
102 | (no external search servers required all in one application) | |
|
103 | - Setup project descriptions/tags and info inside built in db for easy, non | |
|
104 | file-system operations. | |
|
105 | - Intelligent cache with invalidation after push or project change, provides | |
|
106 | high performance and always up to date data. | |
|
107 | - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz | |
|
108 | - Optional async tasks for speed and performance using celery_ | |
|
109 | - Backup scripts can do backup of whole app and send it over scp to desired | |
|
110 | location | |
|
111 | - Based on pylons / sqlalchemy / sqlite / whoosh / vcs | |
|
112 | ||
|
113 | ||
|
114 | Incoming / Plans | |
|
115 | ---------------- | |
|
116 | ||
|
117 | - Finer granular permissions per branch, or subrepo | |
|
118 | - Web based merges for pull requests | |
|
119 | - Tracking history for each lines in files | |
|
120 | - Simple issue tracker | |
|
121 | - SSH based authentication with server side key management | |
|
122 | - Commit based built in wiki system | |
|
123 | - More statistics and graph (global annotation + some more statistics) | |
|
124 | - Other advancements as development continues (or you can of course make | |
|
125 | additions and or requests) | |
|
45 | Check out all features of RhodeCode at https://rhodecode.com/features | |
|
126 | 46 | |
|
127 | 47 | License |
|
128 | 48 | ------- |
|
129 | 49 | |
|
130 | ``RhodeCode`` is released under the GPLv3 license. | |
|
50 | ``RhodeCode`` is released under the GPLv3 license. Please see | |
|
51 | LICENSE file for details | |
|
131 | 52 | |
|
132 | 53 | |
|
133 | 54 | Getting help |
|
134 | 55 | ------------ |
|
135 | 56 | |
|
136 | 57 | Listed bellow are various support resources that should help. |
|
137 | 58 | |
|
138 | 59 | .. note:: |
|
139 | 60 | |
|
140 | 61 | Please try to read the documentation before posting any issues, especially |
|
141 | 62 | the **troubleshooting section** |
|
142 | 63 | |
|
143 | - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask | |
|
144 | any questions. | |
|
64 | - Search the `Knowledge base <https://rhodecode.com/help/dashboard/kb>`_ for | |
|
65 | known issues or problems. | |
|
145 | 66 | |
|
146 | - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ | |
|
67 | - Search the old `Discussion group <http://groups.google.com/group/rhodecode>`_ for | |
|
68 | known issues or problems. (Depracated) | |
|
69 | ||
|
70 | - Open an issue at `support page <https://rhodecode.com/help>`_ | |
|
147 | 71 | |
|
148 | 72 | - Join #rhodecode on FreeNode (irc.freenode.net) |
|
149 | 73 | or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. |
|
150 | 74 | |
|
151 |
- You can also follow |
|
|
152 | news about RhodeCode | |
|
75 | - You can also follow RhodeCode on twitter **@RhodeCode** where we often post | |
|
76 | news and other interesting stuff about RhodeCode. | |
|
153 | 77 | |
|
154 | 78 | |
|
155 | 79 | Online documentation |
|
156 | 80 | -------------------- |
|
157 | 81 | |
|
158 | 82 | Online documentation for the current version of RhodeCode is available at |
|
159 | - http://packages.python.org/RhodeCode/ | |
|
160 | - http://rhodecode.readthedocs.org/en/latest/index.html | |
|
83 | - http://rhodecode.com/docs | |
|
161 | 84 | |
|
162 | 85 | You may also build the documentation for yourself - go into ``docs/`` and run:: |
|
163 | 86 | |
|
164 | 87 | make html |
|
165 | 88 | |
|
166 | 89 | (You need to have sphinx_ installed to build the documentation. If you don't |
|
167 | 90 | have sphinx_ installed you can install it via the command: |
|
168 |
`` |
|
|
91 | ``pip install sphinx``) | |
|
169 | 92 | |
|
170 | 93 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
171 | 94 | .. _python: http://www.python.org/ |
|
172 | 95 | .. _sphinx: http://sphinx.pocoo.org/ |
|
173 | 96 | .. _mercurial: http://mercurial.selenic.com/ |
|
174 | 97 | .. _bitbucket: http://bitbucket.org/ |
|
175 | 98 | .. _github: http://github.com/ |
|
176 | 99 | .. _subversion: http://subversion.tigris.org/ |
|
177 | 100 | .. _git: http://git-scm.com/ |
|
178 | 101 | .. _celery: http://celeryproject.org/ |
|
179 | .. _Sphinx: http://sphinx.pocoo.org/ | |
|
180 | 102 | .. _vcs: http://pypi.python.org/pypi/vcs |
General Comments 0
You need to be logged in to leave comments.
Login now