Show More
@@ -3,14 +3,16 b'' | |||
|
3 | 3 | Welcome to RhodeCode (RhodiumCode) documentation! |
|
4 | 4 | ================================================= |
|
5 | 5 | |
|
6 | ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository | |
|
7 |
browser/management tool with |
|
|
8 |
It works on http/https |
|
|
9 | ability to auth via LDAP. It's similar in some parts to github or bitbucket, | |
|
10 | but it's suppose to run as standalone hosted application, it's open source | |
|
11 | and donation ware and focuses more on providing customized, self administered | |
|
12 | interface for Mercurial(and soon GIT) repositories. It's powered by vcs_ | |
|
13 | library that me and Lukasz Balcerzak created to handle many various version | |
|
6 | ``RhodeCode`` (formerly hg-app) is a Pylons framework based Mercurial repository | |
|
7 | browser/management tool with a built in push/pull server and full text search. | |
|
8 | It works on http/https and has a built in permission/authentication system with | |
|
9 | the ability to authenticate via LDAP. | |
|
10 | ||
|
11 | RhodeCode is similar in some respects to github or bitbucket, | |
|
12 | however RhodeCode can be run as standalone hosted application on your own server. It is open source | |
|
13 | and donation ware and focuses more on providing a customized, self administered | |
|
14 | interface for Mercurial(and soon GIT) repositories. RhodeCode is powered by a vcs_ | |
|
15 | library that Lukasz Balcerzak and I created to handle multiple different version | |
|
14 | 16 | control systems. |
|
15 | 17 | |
|
16 | 18 | RhodeCode uses `Semantic Versioning <http://semver.org/>`_ |
@@ -20,8 +22,8 b' RhodeCode demo' | |||
|
20 | 22 | |
|
21 | 23 | http://hg.python-works.com |
|
22 | 24 | |
|
23 |
The default access is anonymous but |
|
|
24 |
using th |
|
|
25 | The default access is anonymous but you can login to an administrative account | |
|
26 | using the following credentials: | |
|
25 | 27 | |
|
26 | 28 | - username: demo |
|
27 | 29 | - password: demo |
@@ -29,7 +31,7 b' using those credentials' | |||
|
29 | 31 | Source code |
|
30 | 32 | ----------- |
|
31 | 33 | |
|
32 |
The |
|
|
34 | The latest source for RhodeCode can be obtained from my own RhodeCode instance | |
|
33 | 35 | https://rhodecode.org |
|
34 | 36 | |
|
35 | 37 | Rarely updated source code and issue tracker is available at bitbcuket |
@@ -38,32 +40,32 b' http://bitbucket.org/marcinkuzminski/rho' | |||
|
38 | 40 | Installation |
|
39 | 41 | ------------ |
|
40 | 42 | |
|
41 |
|
|
|
43 | Please visit http://packages.python.org/RhodeCode/installation.html | |
|
42 | 44 | |
|
43 | 45 | |
|
44 | Features | |
|
45 | -------- | |
|
46 | RhodeCode Features | |
|
47 | ------------------ | |
|
46 | 48 | |
|
47 | - Has it's own middleware to handle mercurial_ protocol request. | |
|
48 |
Each request can be logged and authenticated. |
|
|
49 | hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https | |
|
49 | - Has it's own middleware to handle mercurial_ protocol requests. | |
|
50 | Each request can be logged and authenticated. | |
|
51 | - Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https | |
|
50 | 52 | and LDAP |
|
51 | 53 | - Full permissions (private/read/write/admin) and authentication per project. |
|
52 | 54 | One account for web interface and mercurial_ push/pull/clone operations. |
|
53 | - Mako templates let's you customize look and feel of application. | |
|
54 | - Beautiful diffs, annotations and source codes all colored by pygments. | |
|
55 | - Mako templates let's you customize the look and feel of the application. | |
|
56 | - Beautiful diffs, annotations and source code browsing all colored by pygments. | |
|
55 | 57 | - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
|
56 | 58 | - Admin interface with user/permission management. Admin activity journal, logs |
|
57 | 59 | pulls, pushes, forks, registrations and other actions made by all users. |
|
58 |
- Server side forks |
|
|
60 | - Server side forks. It is possible to fork a project and modify it freely without | |
|
59 | 61 | breaking the main repository. |
|
60 |
- Full text search powered by Whoosh on source |
|
|
62 | - Full text search powered by Whoosh on the source files, and file names. | |
|
61 | 63 | Build in indexing daemons, with optional incremental index build |
|
62 | 64 | (no external search servers required all in one application) |
|
63 | 65 | - Setup project descriptions and info inside built in db for easy, non |
|
64 | 66 | file-system operations |
|
65 | 67 | - Intelligent cache with invalidation after push or project change, provides high |
|
66 |
performance and always up to date data. |
|
|
68 | performance and always up to date data. | |
|
67 | 69 | - Rss / atom feeds, gravatar support, download sources as zip/tar/gz |
|
68 | 70 | - Async tasks for speed and performance using celery_ (works without them too) |
|
69 | 71 | - Backup scripts can do backup of whole app and send it over scp to desired |
@@ -77,43 +79,46 b' Features' | |||
|
77 | 79 | Incoming / Plans |
|
78 | 80 | ---------------- |
|
79 | 81 | |
|
80 |
- |
|
|
82 | - Project grouping | |
|
81 | 83 | - User groups/teams |
|
82 |
- |
|
|
83 |
- |
|
|
84 |
- |
|
|
85 |
- |
|
|
86 |
- |
|
|
87 |
- |
|
|
88 |
- |
|
|
89 |
- |
|
|
90 | - other cools stuff that i can figure out (or You can help me figure out) | |
|
84 | - SSH based authentication with server side key management | |
|
85 | - Code review (probably based on hg-review) | |
|
86 | - Full git_ support, with push/pull server (currently in beta tests) | |
|
87 | - Redmine integration | |
|
88 | - Public accessible activity feeds | |
|
89 | - Commit based built in wiki system | |
|
90 | - Clone points and cloning from remote repositories into RhodeCode | |
|
91 | - More statistics and graph (global annotation + some more statistics) | |
|
92 | - Other advancements as development continues (or you can of course make additions and or requests) | |
|
91 | 93 | |
|
92 | 94 | License |
|
93 | 95 | ------- |
|
94 | 96 | |
|
95 | ``RhodeCode`` is released under GPL_ license. | |
|
97 | ``RhodeCode`` is released under the GPL_ license. | |
|
96 | 98 | |
|
97 | 99 | |
|
98 | 100 | Mailing group Q&A |
|
99 | 101 | ----------------- |
|
100 | 102 | |
|
101 |
|
|
|
103 | Join the `Google group <http://groups.google.com/group/rhodecode>`_ | |
|
102 | 104 | |
|
103 |
|
|
|
105 | Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ | |
|
104 | 106 | |
|
105 |
|
|
|
107 | Join #rhodecode on FreeNode (irc.freenode.net) | |
|
106 | 108 | or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. |
|
107 | 109 | |
|
108 | 110 | Online documentation |
|
109 | 111 | -------------------- |
|
110 | 112 | |
|
111 |
|
|
|
112 |
|
|
|
113 |
|
|
|
113 | Online documentation for the current version of RhodeCode is available at | |
|
114 | http://packages.python.org/RhodeCode/. | |
|
115 | You may also build the documentation for yourself - go into ``docs/`` and run:: | |
|
114 | 116 | |
|
115 | 117 | make html |
|
116 | 118 | |
|
119 | (You need to have sphinx installed to build the documentation. If you don't | |
|
120 | have sphinx installed you can install it via the command: ``easy_install sphinx``) | |
|
121 | ||
|
117 | 122 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
118 | 123 | .. _python: http://www.python.org/ |
|
119 | 124 | .. _django: http://www.djangoproject.com/ |
@@ -1,17 +1,19 b'' | |||
|
1 | 1 | .. _contributing: |
|
2 | 2 | |
|
3 |
Contributing |
|
|
3 | Contributing to RhodeCode | |
|
4 | 4 | ========================= |
|
5 | 5 | |
|
6 |
If |
|
|
7 |
greatly appreciated |
|
|
6 | If you would like to contribute to RhodeCode, please contact me, any help is | |
|
7 | greatly appreciated! | |
|
8 | 8 | |
|
9 | Preferable method Would be to fork RhodeCode repository from bitbucket | |
|
10 | https://bitbucket.org/marcinkuzminski/rhodecode and then open a pull request. | |
|
11 | This way it's easier for me to merge. | |
|
9 | Could I request that you make your source contributions by first forking the | |
|
10 | RhodeCode repository on bitbucket | |
|
11 | https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to | |
|
12 | your forked repository. Finally, when you are finished making a change, please | |
|
13 | send me a pull request. | |
|
12 | 14 | |
|
13 |
To run RhodeCode in a development version |
|
|
14 | version of RhodeCode and VCS library. | |
|
15 | To run RhodeCode in a development version you always need to install the tip | |
|
16 | version of RhodeCode and the VCS library. | |
|
15 | 17 | |
|
16 | ||
|
17 | Thank You. | |
|
18 | | Thank you for any contributions! | |
|
19 | | Marcin No newline at end of file |
@@ -4,9 +4,9 b' Enabling GIT support (beta)' | |||
|
4 | 4 | =========================== |
|
5 | 5 | |
|
6 | 6 | |
|
7 |
Git support in RhodeCode 1.1 was disabled due to |
|
|
8 |
|
|
|
9 |
uncomment git line in rhodecode/__init__.py |
|
|
7 | Git support in RhodeCode 1.1 was disabled due to current instability issues. However, | |
|
8 | if you would like to test git support please feel free to re-enable it. To re-enable GIT support just | |
|
9 | uncomment the git line in the file rhodecode/__init__.py | |
|
10 | 10 | |
|
11 | 11 | .. code-block:: python |
|
12 | 12 | |
@@ -16,6 +16,7 b' uncomment git line in rhodecode/__init__' | |||
|
16 | 16 | } |
|
17 | 17 | |
|
18 | 18 | .. note:: |
|
19 | Please note that it's not fully stable and it might crash (that's why it | |
|
20 | was disabled), so be careful about enabling git support. Don't use it in | |
|
21 | production ! No newline at end of file | |
|
19 | Please note that the git support provided by RhodeCode is not yet fully | |
|
20 | stable and RhodeCode might crash while using git repositories. (That is why | |
|
21 | it is currently disabled.) Thus be careful about enabling git support, and | |
|
22 | certainly don't use it in a production setting! No newline at end of file |
@@ -3,24 +3,24 b'' | |||
|
3 | 3 | Installation |
|
4 | 4 | ============ |
|
5 | 5 | |
|
6 |
``RhodeCode`` is written entirely in Python |
|
|
7 |
|
|
|
8 |
together with celery |
|
|
6 | ``RhodeCode`` is written entirely in Python. In order to gain maximum performance | |
|
7 | there are some third-party you must install. When RhodeCode is used | |
|
8 | together with celery you have to install some kind of message broker, | |
|
9 | 9 | recommended one is rabbitmq_ to make the async tasks work. |
|
10 | 10 | |
|
11 |
Of course RhodeCode works in sync mode also |
|
|
12 |
any third party apps. Celery_ will give |
|
|
13 |
many big repositories. If |
|
|
14 |
will |
|
|
11 | Of course RhodeCode works in sync mode also and then you do not have to install | |
|
12 | any third party applications. However, using Celery_ will give you a large speed improvement when using | |
|
13 | many big repositories. If you plan to use RhodeCode for say 7 to 10 small repositories, RhodeCode | |
|
14 | will perform perfectly well without celery running. | |
|
15 | 15 | |
|
16 |
|
|
|
16 | If you make the decision to run RhodeCode with celery make sure you run celeryd using paster | |
|
17 | 17 | and message broker together with the application. |
|
18 | 18 | |
|
19 | Install from Cheese Shop | |
|
19 | Installing RhodeCode from Cheese Shop | |
|
20 | 20 | ------------------------ |
|
21 |
Rhodecode requires python |
|
|
21 | Rhodecode requires python version 2.5 or higher. | |
|
22 | 22 | |
|
23 |
|
|
|
23 | The easiest way to install ``rhodecode`` is to run:: | |
|
24 | 24 | |
|
25 | 25 | easy_install rhodecode |
|
26 | 26 | |
@@ -28,8 +28,8 b' Or::' | |||
|
28 | 28 | |
|
29 | 29 | pip install rhodecode |
|
30 | 30 | |
|
31 | If you prefer to install manually simply grab latest release from | |
|
32 | http://pypi.python.org/pypi/rhodecode, decompress archive and run:: | |
|
31 | If you prefer to install RhodeCode manually simply grab latest release from | |
|
32 | http://pypi.python.org/pypi/rhodecode, decompress the archive and run:: | |
|
33 | 33 | |
|
34 | 34 | python setup.py install |
|
35 | 35 | |
@@ -38,15 +38,13 b' Step by step installation example' | |||
|
38 | 38 | --------------------------------- |
|
39 | 39 | |
|
40 | 40 | |
|
41 |
- Assuming |
|
|
42 | ||
|
43 | :: | |
|
41 | - Assuming you have installed virtualenv_ create a new virtual environment using virtualenv:: | |
|
44 | 42 | |
|
45 | 43 | virtualenv --no-site-packages /var/www/rhodecode-venv |
|
46 | 44 | |
|
47 | 45 | |
|
48 | 46 | .. note:: Using ``--no-site-packages`` when generating your |
|
49 | virtualenv is *very important*. This flag provides the necessary | |
|
47 | virtualenv is **very important**. This flag provides the necessary | |
|
50 | 48 | isolation for running the set of packages required by |
|
51 | 49 | RhodeCode. If you do not specify ``--no-site-packages``, |
|
52 | 50 | it's possible that RhodeCode will not install properly into |
@@ -56,48 +54,42 b' Step by step installation example' | |||
|
56 | 54 | |
|
57 | 55 | |
|
58 | 56 | - this will install new virtualenv_ into `/var/www/rhodecode-venv`. |
|
59 |
- Activate the virtualenv_ by running |
|
|
60 | ||
|
61 | :: | |
|
57 | - Activate the virtualenv_ by running:: | |
|
62 | 58 | |
|
63 | 59 | source /var/www/rhodecode-venv/bin/activate |
|
64 | 60 | |
|
65 |
.. note:: If you're |
|
|
61 | .. note:: If you're using UNIX, *do not* use ``sudo`` to run the | |
|
66 | 62 | ``virtualenv`` script. It's perfectly acceptable (and desirable) |
|
67 | 63 | to create a virtualenv as a normal user. |
|
68 | 64 | |
|
69 |
- Make a folder for rhodecode somewhere on the filesystem for example |
|
|
70 | ||
|
71 | :: | |
|
65 | - Make a folder for rhodecode somewhere on the filesystem for example:: | |
|
72 | 66 | |
|
73 | 67 | mkdir /var/www/rhodecode |
|
74 | 68 | |
|
75 | 69 | |
|
76 | - Run this command to install rhodecode | |
|
77 | ||
|
78 | :: | |
|
70 | - Run this command to install rhodecode:: | |
|
79 | 71 | |
|
80 | 72 | easy_install rhodecode |
|
81 | 73 | |
|
82 |
- |
|
|
83 | and all other required python libraries | |
|
74 | - This will install rhodecode together with pylons and all other required python | |
|
75 | libraries | |
|
84 | 76 | |
|
85 | 77 | Requirements for Celery (optional) |
|
86 | 78 | ---------------------------------- |
|
87 | 79 | |
|
88 | 80 | .. note:: |
|
89 | 81 | Installing message broker and using celery is optional, RhodeCode will |
|
90 |
work |
|
|
82 | work perfectly fine without them. | |
|
91 | 83 | |
|
92 | 84 | |
|
93 | 85 | **Message Broker** |
|
94 | 86 | |
|
95 | 87 | - preferred is `RabbitMq <http://www.rabbitmq.com/>`_ |
|
96 |
- possible |
|
|
88 | - A possible alternative is `Redis <http://code.google.com/p/redis/>`_ | |
|
97 | 89 | |
|
98 |
For installation instructions |
|
|
99 | http://ask.github.com/celery/getting-started/index.html | |
|
100 |
|
|
|
90 | For installation instructions you can visit: | |
|
91 | http://ask.github.com/celery/getting-started/index.html. | |
|
92 | This is a very nice tutorial on how to start using celery_ with rabbitmq_ | |
|
101 | 93 | |
|
102 | 94 | |
|
103 | 95 | You can now proceed to :ref:`setup` |
@@ -31,7 +31,7 b' entering this "root" path ``setup-app`` ' | |||
|
31 | 31 | for the initial admin account which ``setup-app`` sets up for you. |
|
32 | 32 | |
|
33 | 33 | - The ``setup-app`` command will create all of the needed tables and an admin |
|
34 |
account. When choosing a root path |
|
|
34 | account. When choosing a root path you can either use a new empty location, or a | |
|
35 | 35 | location which already contains existing repositories. If you choose a location |
|
36 | 36 | which contains existing repositories RhodeCode will simply add all of the |
|
37 | 37 | repositories at the chosen location to it's database. (Note: make sure you |
@@ -51,7 +51,7 b' You are now ready to use RhodeCode, to r' | |||
|
51 | 51 | - Use the admin account you created above when running ``setup-app`` to login to the web app. |
|
52 | 52 | - The default permissions on each repository is read, and the owner is admin. |
|
53 | 53 | Remember to update these if needed. |
|
54 |
- In the admin panel |
|
|
54 | - In the admin panel you can toggle ldap, anonymous, permissions settings. As | |
|
55 | 55 | well as edit more advanced options on users and repositories |
|
56 | 56 | |
|
57 | 57 | Try copying your own mercurial repository into the "root" directory you are |
@@ -102,7 +102,7 b' Setting up Whoosh full text search' | |||
|
102 | 102 | ---------------------------------- |
|
103 | 103 | |
|
104 | 104 | Starting from version 1.1 the whoosh index can be build by using the paster |
|
105 |
command ``make-index``. To use ``make-index`` |
|
|
105 | command ``make-index``. To use ``make-index`` you must specify the configuration | |
|
106 | 106 | file that stores the location of the index, and the location of the repositories |
|
107 | 107 | (`--repo-location`). |
|
108 | 108 |
@@ -4,29 +4,30 b'' | |||
|
4 | 4 | Statistics |
|
5 | 5 | ========== |
|
6 | 6 | |
|
7 |
RhodeCode statistics system |
|
|
8 |
balance between |
|
|
9 |
and are gathered incrementally, this is how RhodeCode does |
|
|
7 | The RhodeCode statistics system makes heavy demands of the server resources, so | |
|
8 | in order to keep a balance between usability and performance, the statistics are | |
|
9 | cached inside db and are gathered incrementally, this is how RhodeCode does | |
|
10 | this: | |
|
10 | 11 | |
|
11 | 12 | With Celery disabled |
|
12 | 13 | ++++++++++++++++++++ |
|
13 | 14 | |
|
14 |
- |
|
|
15 | updates statistics cache | |
|
16 |
- |
|
|
17 |
fetched. Statistics are kept cached until |
|
|
18 |
repository |
|
|
19 |
updat |
|
|
15 | - On each first visit to the summary page a set of 250 commits are parsed and | |
|
16 | updates statistics cache. | |
|
17 | - This happens on each single visit to the statistics page until all commits are | |
|
18 | fetched. Statistics are kept cached until additional commits are added to the | |
|
19 | repository. In such a case RhodeCode will only fetch the new commits when | |
|
20 | updating it's cache. | |
|
20 | 21 | |
|
21 | 22 | |
|
22 | 23 | With Celery enabled |
|
23 | 24 | +++++++++++++++++++ |
|
24 | 25 | |
|
25 |
- |
|
|
26 |
on celery workers |
|
|
27 |
each task will parse 250 commits, and run next task to |
|
|
28 | commits, until all are parsed. | |
|
26 | - On the first visit to the summary page RhodeCode will create tasks that will | |
|
27 | execute on celery workers. This task will gather all of the stats until all | |
|
28 | commits are parsed, each task will parse 250 commits, and run the next task to | |
|
29 | parse next 250 commits, until all of the commits are parsed. | |
|
29 | 30 | |
|
30 | 31 | .. note:: |
|
31 |
|
|
|
32 |
form in admin panel |
|
|
32 | At any time you can disable statistics on each repository via the repository | |
|
33 | edit form in the admin panel. To do this just uncheck the statistics checkbox. No newline at end of file |
@@ -3,10 +3,13 b'' | |||
|
3 | 3 | Upgrade |
|
4 | 4 | ======= |
|
5 | 5 | |
|
6 |
Upgrad |
|
|
6 | Upgrading from Cheese Shop | |
|
7 | 7 | ------------------------ |
|
8 | 8 | |
|
9 | Easiest way to upgrade ``rhodecode`` is to run:: | |
|
9 | .. note:: | |
|
10 | Firstly, it is recommended that you **always** perform a database backup before doing an upgrade. | |
|
11 | ||
|
12 | The easiest way to upgrade ``rhodecode`` is to run:: | |
|
10 | 13 | |
|
11 | 14 | easy_install -U rhodecode |
|
12 | 15 | |
@@ -15,39 +18,31 b' Or::' | |||
|
15 | 18 | pip install --upgrade rhodecode |
|
16 | 19 | |
|
17 | 20 | |
|
18 |
Then make sure |
|
|
19 | ||
|
20 | :: | |
|
21 | Then make sure you run the following command from the installation directory:: | |
|
21 | 22 | |
|
22 | 23 | paster make-config RhodeCode production.ini |
|
23 | 24 | |
|
24 |
This will display any changes made |
|
|
25 |
current config |
|
|
26 | of config file and recheck the content after merge. | |
|
25 | This will display any changes made by the new version of RhodeCode to your | |
|
26 | current configuration. It will try to perform an automerge. It's always better | |
|
27 | to make a backup of your configuration file before hand and recheck the content after the automerge. | |
|
27 | 28 | |
|
28 | 29 | .. note:: |
|
29 | 30 | The next steps only apply to upgrading from non bugfix releases eg. from |
|
30 | 31 | any minor or major releases. Bugfix releases (eg. 1.1.2->1.1.3) will |
|
31 | not have any database schema changes or whoosh library updates | |
|
32 | not have any database schema changes or whoosh library updates. | |
|
32 | 33 | |
|
33 |
It |
|
|
34 |
version |
|
|
34 | It is also recommended that you rebuild the whoosh index after upgrading since the new whoosh | |
|
35 | version could introduce some incompatible index changes. | |
|
35 | 36 | |
|
36 | 37 | |
|
37 |
The l |
|
|
38 | ||
|
39 | :: | |
|
38 | The final step is to upgrade the database. To do this simply run:: | |
|
40 | 39 | |
|
41 | 40 | paster upgrade-db production.ini |
|
42 | 41 | |
|
43 |
This will upgrade schema |
|
|
44 | always recheck the settings of the application, if there are no new options | |
|
42 | This will upgrade the schema and update some of the defaults in the database, | |
|
43 | and will always recheck the settings of the application, if there are no new options | |
|
45 | 44 | that need to be set. |
|
46 | 45 | |
|
47 | .. note:: | |
|
48 | Always perform a database backup before doing upgrade. | |
|
49 | ||
|
50 | ||
|
51 | 46 | |
|
52 | 47 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
53 | 48 | .. _python: http://www.python.org/ |
General Comments 0
You need to be logged in to leave comments.
Login now