Mercurial > kallithea

comparison README.rst @ 1093:615c1bc11889 beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
readme update
author Marcin Kuzminski <marcin@python-works.com>
date Sat, 26 Feb 2011 23:41:42 +0100
parents 053983a464e4
children 9472a0150bf0
comparison
equal deleted inserted replaced
1092:8af52e1224ff 1093:615c1bc11889
1 1
2 ================================================= 2 =================================================
3 Welcome to RhodeCode (RhodiumCode) documentation! 3 Welcome to RhodeCode (RhodiumCode) documentation!
4 ================================================= 4 =================================================
5 5
6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository 6 ``RhodeCode`` (formerly hg-app) is a Pylons framework based Mercurial repository
7 browser/management tool with build in push/pull server and full text search. 7 browser/management tool with a built in push/pull server and full text search.
8 It works on http/https, has build in permission/authentication system with 8 It works on http/https and has a built in permission/authentication system with
9 ability to auth via LDAP. It's similar in some parts to github or bitbucket, 9 the ability to authenticate via LDAP.
10 but it's suppose to run as standalone hosted application, it's open source 10
11 and donation ware and focuses more on providing customized, self administered 11 RhodeCode is similar in some respects to github or bitbucket,
12 interface for Mercurial(and soon GIT) repositories. It's powered by vcs_ 12 however RhodeCode can be run as standalone hosted application on your own server.
13 library that me and Lukasz Balcerzak created to handle many various version 13 It is open source and donation ware and focuses more on providing a customized,
14 control systems. 14 self administered interface for Mercurial(and soon GIT) repositories.
15 RhodeCode is powered by a vcs_ library that Lukasz Balcerzak and I created to
16 handle multiple different version control systems.
15 17
16 RhodeCode uses `Semantic Versioning <http://semver.org/>`_ 18 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
17 19
18 RhodeCode demo 20 RhodeCode demo
19 -------------- 21 --------------
20 22
21 http://hg.python-works.com 23 http://hg.python-works.com
22 24
23 The default access is anonymous but You can login to administrative account 25 The default access is anonymous but you can login to an administrative account
24 using those credentials 26 using the following credentials:
25 27
26 - username: demo 28 - username: demo
27 - password: demo 29 - password: demo
28 30
29 Source code 31 Source code
30 ----------- 32 -----------
31 33
32 The most up to date sources can be obtained from my own RhodeCode instance 34 The latest source for RhodeCode can be obtained from my own RhodeCode instance
33 https://rhodecode.org 35 https://rhodecode.org
34 36
35 Rarely updated source code and issue tracker is available at bitbcuket 37 Rarely updated source code and issue tracker is available at bitbcuket
36 http://bitbucket.org/marcinkuzminski/rhodecode 38 http://bitbucket.org/marcinkuzminski/rhodecode
37 39
38 Installation 40 Installation
39 ------------ 41 ------------
40 42
41 Please visit http://packages.python.org/RhodeCode/installation.html 43 Please visit http://packages.python.org/RhodeCode/installation.html
42 44
43 45
44 Features 46 RhodeCode Features
45 -------- 47 ------------------
46 48
47 - Has it's own middleware to handle mercurial_ protocol request. 49 - Has it's own middleware to handle mercurial_ protocol requests.
48 Each request can be logged and authenticated. Runs on threads unlikely to 50 Each request can be logged and authenticated.
49 hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https 51 - Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https
50 and LDAP 52 and LDAP
51 - Full permissions (private/read/write/admin) and authentication per project. 53 - Full permissions (private/read/write/admin) and authentication per project.
52 One account for web interface and mercurial_ push/pull/clone operations. 54 One account for web interface and mercurial_ push/pull/clone operations.
53 - Have built in users groups for easier permission management 55 - Have built in users groups for easier permission management
54 - Users can fork other users repo. RhodeCode have also compare view to see 56 - Users can fork other users repo. RhodeCode have also compare view to see
55 combined changeset for all changeset made within single push. 57 combined changeset for all changeset made within single push.
56 - Mako templates let's you customize look and feel of application. 58 - Mako templates let's you customize the look and feel of the application.
57 - Beautiful diffs, annotations and source codes all colored by pygments. Raw 59 - Beautiful diffs, annotations and source code browsing all colored by pygments. Raw
58 diffs are made in git-diff format, including git binary-patches 60 diffs are made in git-diff format, including git binary-patches
59 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics 61 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
60 - Admin interface with user/permission management. Admin activity journal, logs 62 - Admin interface with user/permission management. Admin activity journal, logs
61 pulls, pushes, forks, registrations and other actions made by all users. 63 pulls, pushes, forks, registrations and other actions made by all users.
62 - Server side forks, it's possible to fork a project and hack it free without 64 - Server side forks. It is possible to fork a project and modify it freely without
63 breaking the main repository. You can even write Your own hooks and install 65 breaking the main repository. You can even write Your own hooks and install
64 them 66 them
65 - Full text search powered by Whoosh on source codes, and file names. 67 - Full text search powered by Whoosh on the source files, and file names.
66 Build in indexing daemons, with optional incremental index build 68 Build in indexing daemons, with optional incremental index build
67 (no external search servers required. All in one application !) 69 (no external search servers required all in one application)
68 - Setup project descriptions and info inside built in db for easy, non 70 - Setup project descriptions and info inside built in db for easy, non
69 file-system operations 71 file-system operations
70 - Intelligent cache with invalidation after push or project change, provides 72 - Intelligent cache with invalidation after push or project change, provides high
71 high performance and always up to date data. 73 performance and always up to date data.
72 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz 74 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz
73 - Async tasks for speed and performance using celery_ (works without them too) 75 - Async tasks for speed and performance using celery_ (works without them too)
74 - Backup scripts can do backup of whole app and send it over scp to desired 76 - Backup scripts can do backup of whole app and send it over scp to desired
75 location 77 location
76 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs 78 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
80 82
81 83
82 Incoming / Plans 84 Incoming / Plans
83 ---------------- 85 ----------------
84 86
85 - project grouping 87 - Project grouping
86 - code review (probably based on hg-review) 88 - SSH based authentication with server side key management
87 - full git_ support, with push/pull server (currently in beta tests) 89 - Code review (probably based on hg-review)
88 - redmine integration 90 - Full git_ support, with push/pull server (currently in beta tests)
89 - public accessible activity feeds 91 - Redmine integration
90 - commit based build in wiki system 92 - Public accessible activity feeds
91 - clone points and cloning from remote repositories into rhodecode 93 - Commit based built in wiki system
92 (git_ and mercurial_) 94 - Clone points and cloning from remote repositories into RhodeCode
93 - more statistics and graph (global annotation + some more statistics) 95 - More statistics and graph (global annotation + some more statistics)
94 - other cools stuff that i can figure out (or You can help me figure out) 96 - Other advancements as development continues (or you can of course make additions and or requests)
95 97
96 License 98 License
97 ------- 99 -------
98 100
99 ``rhodecode`` is released under GPL_ license. 101 ``RhodeCode`` is released under the GPL_ license.
100 102
101 103
102 Mailing group Q&A 104 Mailing group Q&A
103 ----------------- 105 -----------------
104 106
105 join the `Google group <http://groups.google.com/group/rhodecode>`_ 107 Join the `Google group <http://groups.google.com/group/rhodecode>`_
106 108
107 open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ 109 Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
108 110
109 join #rhodecode on FreeNode (irc.freenode.net) 111 Join #rhodecode on FreeNode (irc.freenode.net)
110 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. 112 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
111 113
112 Online documentation 114 Online documentation
113 -------------------- 115 --------------------
114 116
115 Online documentation for current version is available at 117 Online documentation for the current version of RhodeCode is available at
116 http://packages.python.org/RhodeCode/. 118 http://packages.python.org/RhodeCode/.
117 You may also build documentation for yourself - go into ``docs/`` and run:: 119 You may also build the documentation for yourself - go into ``docs/`` and run::
118 120
119 make html 121 make html
120 122
123 (You need to have sphinx installed to build the documentation. If you don't
124 have sphinx installed you can install it via the command: ``easy_install sphinx``)
125
121 .. _virtualenv: http://pypi.python.org/pypi/virtualenv 126 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
122 .. _python: http://www.python.org/ 127 .. _python: http://www.python.org/
123 .. _django: http://www.djangoproject.com/ 128 .. _django: http://www.djangoproject.com/
124 .. _mercurial: http://mercurial.selenic.com/ 129 .. _mercurial: http://mercurial.selenic.com/
125 .. _subversion: http://subversion.tigris.org/ 130 .. _subversion: http://subversion.tigris.org/