Show More
@@ -0,0 +1,11 b'' | |||||
|
1 | .. _api_key_access: | |||
|
2 | ||||
|
3 | Access to RhodeCode via API KEY | |||
|
4 | =============================== | |||
|
5 | ||||
|
6 | Starting from version 1.2 rss/atom feeds and journal feeds | |||
|
7 | can be accessed via **api_key**. This unique key is automatically generated for | |||
|
8 | each user in RhodeCode application. Using this key it is possible to access | |||
|
9 | feeds without having to log in. When user changes his password a new API KEY | |||
|
10 | is generated for him automatically. You can check your API KEY in account | |||
|
11 | settings page. No newline at end of file |
@@ -8,7 +8,7 b' browser/management tool with a built in ' | |||||
8 | It works on http/https and has a built in permission/authentication system with |
|
8 | It works on http/https and has a built in permission/authentication system with | |
9 | the ability to authenticate via LDAP. |
|
9 | the ability to authenticate via LDAP. | |
10 |
|
10 | |||
11 | RhodeCode is similar in some respects to github or bitbucket, |
|
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. |
|
12 | however RhodeCode can be run as standalone hosted application on your own server. | |
13 | It is open source and donation ware and focuses more on providing a customized, |
|
13 | It is open source and donation ware and focuses more on providing a customized, | |
14 | self administered interface for Mercurial(and soon GIT) repositories. |
|
14 | self administered interface for Mercurial(and soon GIT) repositories. | |
@@ -57,7 +57,7 b' RhodeCode Features' | |||||
57 | combined changeset for all changeset made within single push. |
|
57 | combined changeset for all changeset made within single push. | |
58 | - Mako templates let's you customize the look and feel of the application. |
|
58 | - Mako templates let's you customize the look and feel of the application. | |
59 | - Beautiful diffs, annotations and source code browsing all colored by pygments. Raw |
|
59 | - Beautiful diffs, annotations and source code browsing all colored by pygments. Raw | |
60 | diffs are made in git-diff format, including git binary-patches |
|
60 | diffs are made in git-diff format, including git_ binary-patches | |
61 | - 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 | |
62 | - Admin interface with user/permission management. Admin activity journal, logs |
|
62 | - Admin interface with user/permission management. Admin activity journal, logs | |
63 | pulls, pushes, forks, registrations and other actions made by all users. |
|
63 | pulls, pushes, forks, registrations and other actions made by all users. | |
@@ -127,6 +127,7 b' have sphinx installed you can install it' | |||||
127 | .. _python: http://www.python.org/ |
|
127 | .. _python: http://www.python.org/ | |
128 | .. _django: http://www.djangoproject.com/ |
|
128 | .. _django: http://www.djangoproject.com/ | |
129 | .. _mercurial: http://mercurial.selenic.com/ |
|
129 | .. _mercurial: http://mercurial.selenic.com/ | |
|
130 | .. _bitbucket: http://bitbucket.org/ | |||
130 | .. _subversion: http://subversion.tigris.org/ |
|
131 | .. _subversion: http://subversion.tigris.org/ | |
131 | .. _git: http://git-scm.com/ |
|
132 | .. _git: http://git-scm.com/ | |
132 | .. _celery: http://celeryproject.org/ |
|
133 | .. _celery: http://celeryproject.org/ |
@@ -16,7 +16,6 b' news' | |||||
16 | - implemented #91 added nicer looking archive urls with more download options |
|
16 | - implemented #91 added nicer looking archive urls with more download options | |
17 | like tags, branches |
|
17 | like tags, branches | |
18 | - implemented #44 into file browsing, and added follow branch option |
|
18 | - implemented #44 into file browsing, and added follow branch option | |
19 | - implemented #102 allowing '.' in username |
|
|||
20 | - implemented #84 downloads can be enabled/disabled for each repository |
|
19 | - implemented #84 downloads can be enabled/disabled for each repository | |
21 | - anonymous repository can be cloned without having to pass default:default |
|
20 | - anonymous repository can be cloned without having to pass default:default | |
22 | into clone url |
|
21 | into clone url | |
@@ -26,13 +25,16 b' news' | |||||
26 | - implemented #107 customizable code highlights on code sources |
|
25 | - implemented #107 customizable code highlights on code sources | |
27 | - implemented #93 customizable changelog on combined revision ranges - |
|
26 | - implemented #93 customizable changelog on combined revision ranges - | |
28 | equivalent of githubs compare view |
|
27 | equivalent of githubs compare view | |
29 |
- implemented #108 extended and more powerful |
|
28 | - implemented #108 extended and more powerful LDAP configuration | |
30 | - implemented #56 users groups |
|
29 | - implemented #56 users groups | |
31 | - major code rewrites optimized codes for speed and memory usage |
|
30 | - major code rewrites optimized codes for speed and memory usage | |
32 | - raw and diff downloads are now in git format |
|
31 | - raw and diff downloads are now in git format | |
33 | - setup command checks for write access to given path |
|
32 | - setup command checks for write access to given path | |
34 | - fixed many issues with international characters and unicode. It uses utf8 |
|
33 | - fixed many issues with international characters and unicode. It uses utf8 | |
35 | decode with replace to provide less errors even with non utf8 encoded strings |
|
34 | decode with replace to provide less errors even with non utf8 encoded strings | |
|
35 | - #125 added API KEY access to feeds | |||
|
36 | - #109 Repository can be created from external Mercurial link, and manually | |||
|
37 | updated (via pull) from admin panel | |||
36 |
|
38 | |||
37 | fixes |
|
39 | fixes | |
38 | ----- |
|
40 | ----- | |
@@ -46,6 +48,7 b' fixes' | |||||
46 | - journal fork fixes |
|
48 | - journal fork fixes | |
47 | - removed issue with space inside renamed repository after deletion |
|
49 | - removed issue with space inside renamed repository after deletion | |
48 | - fixed strange issue on formencode imports |
|
50 | - fixed strange issue on formencode imports | |
|
51 | - fixed #126 Deleting repository on Windows, rename used incompatible chars. | |||
49 |
|
52 | |||
50 | 1.1.4 (**2011-02-19**) |
|
53 | 1.1.4 (**2011-02-19**) | |
51 | ====================== |
|
54 | ====================== |
@@ -7,13 +7,19 b' If you would like to contribute to Rhode' | |||||
7 | greatly appreciated! |
|
7 | greatly appreciated! | |
8 |
|
8 | |||
9 | Could I request that you make your source contributions by first forking the |
|
9 | Could I request that you make your source contributions by first forking the | |
10 | RhodeCode repository on bitbucket |
|
10 | RhodeCode repository on bitbucket_ | |
11 | https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to |
|
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 |
|
12 | your forked repository. Please post all fixes into **BETA** branch since your | |
13 | send me a pull request. |
|
13 | fix might be already fixed there and i try to merge all fixes from beta into | |
|
14 | stable, and not the other way. Finally, when you are finished making a change, | |||
|
15 | please send me a pull request. | |||
14 |
|
16 | |||
15 | To run RhodeCode in a development version you always need to install the tip |
|
17 | To run RhodeCode in a development version you always need to install the tip | |
16 | version of RhodeCode and the VCS library. |
|
18 | version of RhodeCode and the VCS library. | |
17 |
|
19 | |||
18 | | Thank you for any contributions! |
|
20 | | Thank you for any contributions! | |
19 | | Marcin |
|
21 | | Marcin | |
|
22 | ||||
|
23 | ||||
|
24 | ||||
|
25 | .. _bitbucket: http://bitbucket.org/ |
@@ -23,6 +23,7 b' Documentation' | |||||
23 | usage/enable_git |
|
23 | usage/enable_git | |
24 | usage/statistics |
|
24 | usage/statistics | |
25 | usage/backup |
|
25 | usage/backup | |
|
26 | usage/api_key_access | |||
26 |
|
27 | |||
27 | **Develop** |
|
28 | **Develop** | |
28 |
|
29 | |||
@@ -50,9 +51,10 b' Other topics' | |||||
50 | .. _python: http://www.python.org/ |
|
51 | .. _python: http://www.python.org/ | |
51 | .. _django: http://www.djangoproject.com/ |
|
52 | .. _django: http://www.djangoproject.com/ | |
52 | .. _mercurial: http://mercurial.selenic.com/ |
|
53 | .. _mercurial: http://mercurial.selenic.com/ | |
|
54 | .. _bitbucket: http://bitbucket.org/ | |||
53 | .. _subversion: http://subversion.tigris.org/ |
|
55 | .. _subversion: http://subversion.tigris.org/ | |
54 | .. _git: http://git-scm.com/ |
|
56 | .. _git: http://git-scm.com/ | |
55 | .. _celery: http://celeryproject.org/ |
|
57 | .. _celery: http://celeryproject.org/ | |
56 | .. _Sphinx: http://sphinx.pocoo.org/ |
|
58 | .. _Sphinx: http://sphinx.pocoo.org/ | |
57 | .. _GPL: http://www.gnu.org/licenses/gpl.html |
|
59 | .. _GPL: http://www.gnu.org/licenses/gpl.html | |
58 |
.. _vcs: http://pypi.python.org/pypi/vcs |
|
60 | .. _vcs: http://pypi.python.org/pypi/vcs No newline at end of file |
@@ -9,12 +9,13 b' together with celery you have to install' | |||||
9 | recommended one is rabbitmq_ to make the async tasks work. |
|
9 | recommended one is rabbitmq_ to make the async tasks work. | |
10 |
|
10 | |||
11 | Of course RhodeCode works in sync mode also and then you do not have to install |
|
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 |
|
12 | any third party applications. However, using Celery_ will give you a large | |
13 | many big repositories. If you plan to use RhodeCode for say 7 to 10 small repositories, RhodeCode |
|
13 | speed improvement when using many big repositories. If you plan to use | |
14 | will perform perfectly well without celery running. |
|
14 | RhodeCode for say 7 to 10 small repositories, RhodeCode will perform perfectly | |
|
15 | well without celery running. | |||
15 |
|
16 | |||
16 |
If you make the decision to run RhodeCode with celery make sure you run |
|
17 | If you make the decision to run RhodeCode with celery make sure you run | |
17 | and message broker together with the application. |
|
18 | celeryd using paster and message broker together with the application. | |
18 |
|
19 | |||
19 | Installing RhodeCode from Cheese Shop |
|
20 | Installing RhodeCode from Cheese Shop | |
20 | ------------------------------------- |
|
21 | ------------------------------------- |
@@ -10,7 +10,7 b' Setting up RhodeCode' | |||||
10 | First, you will need to create a RhodeCode configuration file. Run the following |
|
10 | First, you will need to create a RhodeCode configuration file. Run the following | |
11 | command to do this:: |
|
11 | command to do this:: | |
12 |
|
12 | |||
13 | paster make-config RhodeCode production.ini |
|
13 | paster make-config RhodeCode production.ini | |
14 |
|
14 | |||
15 | - This will create the file `production.ini` in the current directory. This |
|
15 | - This will create the file `production.ini` in the current directory. This | |
16 | configuration file contains the various settings for RhodeCode, e.g proxy port, |
|
16 | configuration file contains the various settings for RhodeCode, e.g proxy port, | |
@@ -23,7 +23,7 b' default ensure you properly adjust the d' | |||||
23 | configuration file to use this other database. Create the databases by running |
|
23 | configuration file to use this other database. Create the databases by running | |
24 | the following command:: |
|
24 | the following command:: | |
25 |
|
25 | |||
26 | paster setup-app production.ini |
|
26 | paster setup-app production.ini | |
27 |
|
27 | |||
28 | This will prompt you for a "root" path. This "root" path is the location where |
|
28 | This will prompt you for a "root" path. This "root" path is the location where | |
29 | RhodeCode will store all of its repositories on the current machine. After |
|
29 | RhodeCode will store all of its repositories on the current machine. After | |
@@ -43,7 +43,7 b' for the initial admin account which ``se' | |||||
43 |
|
43 | |||
44 | You are now ready to use RhodeCode, to run it simply execute:: |
|
44 | You are now ready to use RhodeCode, to run it simply execute:: | |
45 |
|
45 | |||
46 | paster serve production.ini |
|
46 | paster serve production.ini | |
47 |
|
47 | |||
48 | - This command runs the RhodeCode server. The web app should be available at the |
|
48 | - This command runs the RhodeCode server. The web app should be available at the | |
49 | 127.0.0.1:5000. This ip and port is configurable via the production.ini |
|
49 | 127.0.0.1:5000. This ip and port is configurable via the production.ini | |
@@ -60,7 +60,7 b' repositories. Then choose Add New Reposi' | |||||
60 | the root. Test that you can browse your repository from within RhodeCode and then |
|
60 | the root. Test that you can browse your repository from within RhodeCode and then | |
61 | try cloning your repository from RhodeCode with:: |
|
61 | try cloning your repository from RhodeCode with:: | |
62 |
|
62 | |||
63 | hg clone http://127.0.0.1:5000/<repository name> |
|
63 | hg clone http://127.0.0.1:5000/<repository name> | |
64 |
|
64 | |||
65 | where *repository name* is replaced by the name of your repository. |
|
65 | where *repository name* is replaced by the name of your repository. | |
66 |
|
66 | |||
@@ -128,7 +128,7 b' In order to do periodical index builds a' | |||||
128 | It's recommended to do a crontab entry for incremental indexing. |
|
128 | It's recommended to do a crontab entry for incremental indexing. | |
129 | An example entry might look like this:: |
|
129 | An example entry might look like this:: | |
130 |
|
130 | |||
131 | /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos> |
|
131 | /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos> | |
132 |
|
132 | |||
133 | When using incremental mode (the default) whoosh will check the last |
|
133 | When using incremental mode (the default) whoosh will check the last | |
134 | modification date of each file and add it to be reindexed if a newer file is |
|
134 | modification date of each file and add it to be reindexed if a newer file is | |
@@ -148,11 +148,11 b' via pypi, so you can install it by runni' | |||||
148 |
|
148 | |||
149 | :: |
|
149 | :: | |
150 |
|
150 | |||
151 | easy_install python-ldap |
|
151 | easy_install python-ldap | |
152 |
|
152 | |||
153 | :: |
|
153 | :: | |
154 |
|
154 | |||
155 | pip install python-ldap |
|
155 | pip install python-ldap | |
156 |
|
156 | |||
157 | .. note:: |
|
157 | .. note:: | |
158 | python-ldap requires some certain libs on your system, so before installing |
|
158 | python-ldap requires some certain libs on your system, so before installing |
@@ -7,7 +7,8 b' Upgrading from Cheese Shop' | |||||
7 | -------------------------- |
|
7 | -------------------------- | |
8 |
|
8 | |||
9 | .. note:: |
|
9 | .. note:: | |
10 |
Firstly, it is recommended that you **always** perform a database backup |
|
10 | Firstly, it is recommended that you **always** perform a database backup | |
|
11 | before doing an upgrade. | |||
11 |
|
12 | |||
12 | The easiest way to upgrade ``rhodecode`` is to run:: |
|
13 | The easiest way to upgrade ``rhodecode`` is to run:: | |
13 |
|
14 | |||
@@ -24,15 +25,16 b' Then make sure you run the following com' | |||||
24 |
|
25 | |||
25 | This will display any changes made by the new version of RhodeCode to your |
|
26 | 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 | 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 |
|
28 | to make a backup of your configuration file before hand and recheck the | |
|
29 | content after the automerge. | |||
28 |
|
30 | |||
29 | .. note:: |
|
31 | .. note:: | |
30 | The next steps only apply to upgrading from non bugfix releases eg. from |
|
32 | The next steps only apply to upgrading from non bugfix releases eg. from | |
31 | any minor or major releases. Bugfix releases (eg. 1.1.2->1.1.3) will |
|
33 | any minor or major releases. Bugfix releases (eg. 1.1.2->1.1.3) will | |
32 | not have any database schema changes or whoosh library updates. |
|
34 | not have any database schema changes or whoosh library updates. | |
33 |
|
35 | |||
34 |
It is also recommended that you rebuild the whoosh index after upgrading since |
|
36 | It is also recommended that you rebuild the whoosh index after upgrading since | |
35 | version could introduce some incompatible index changes. |
|
37 | the new whoosh version could introduce some incompatible index changes. | |
36 |
|
38 | |||
37 |
|
39 | |||
38 | The final step is to upgrade the database. To do this simply run:: |
|
40 | The final step is to upgrade the database. To do this simply run:: | |
@@ -40,8 +42,8 b' The final step is to upgrade the databas' | |||||
40 | paster upgrade-db production.ini |
|
42 | paster upgrade-db production.ini | |
41 |
|
43 | |||
42 | This will upgrade the schema and update some of the defaults in the database, |
|
44 | 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 |
|
45 | and will always recheck the settings of the application, if there are no new | |
44 | that need to be set. |
|
46 | options that need to be set. | |
45 |
|
47 | |||
46 |
|
48 | |||
47 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
49 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
@@ -4,9 +4,10 b' Enabling GIT support (beta)' | |||||
4 | =========================== |
|
4 | =========================== | |
5 |
|
5 | |||
6 |
|
6 | |||
7 |
Git support in RhodeCode 1.1 was disabled due to current instability issues. |
|
7 | Git support in RhodeCode 1.1 was disabled due to current instability issues. | |
8 |
if you would like to test git support please feel free to re-enable it. |
|
8 | However,if you would like to test git support please feel free to re-enable it. | |
9 | uncomment the git line in the file rhodecode/__init__.py |
|
9 | To re-enable GIT support just uncomment the git line in the | |
|
10 | file **rhodecode/__init__.py** | |||
10 |
|
11 | |||
11 | .. code-block:: python |
|
12 | .. code-block:: python | |
12 |
|
13 |
@@ -5,7 +5,7 b' General RhodeCode usage' | |||||
5 |
|
5 | |||
6 |
|
6 | |||
7 | Repository deleting |
|
7 | Repository deleting | |
8 | +++++++++++++++++++ |
|
8 | ------------------- | |
9 |
|
9 | |||
10 | Currently when admin/owner deletes a repository, RhodeCode does not physically |
|
10 | Currently when admin/owner deletes a repository, RhodeCode does not physically | |
11 | delete a repository from filesystem, it renames it in a special way so it's |
|
11 | delete a repository from filesystem, it renames it in a special way so it's | |
@@ -15,7 +15,7 b' delete a repository You can easy restore' | |||||
15 | from the repository name, and internal repository storage (.hg/.git) |
|
15 | from the repository name, and internal repository storage (.hg/.git) | |
16 |
|
16 | |||
17 | Follow current branch in file view |
|
17 | Follow current branch in file view | |
18 | ++++++++++++++++++++++++++++++++++ |
|
18 | ---------------------------------- | |
19 |
|
19 | |||
20 | In file view when this checkbox is checked the << and >> arrows will jump |
|
20 | In file view when this checkbox is checked the << and >> arrows will jump | |
21 | to changesets within the same branch currently viewing. So for example |
|
21 | to changesets within the same branch currently viewing. So for example | |
@@ -24,7 +24,7 b' checkbox the << and >> buttons will only' | |||||
24 |
|
24 | |||
25 |
|
25 | |||
26 | Compare view from changelog |
|
26 | Compare view from changelog | |
27 | +++++++++++++++++++++++++++ |
|
27 | --------------------------- | |
28 |
|
28 | |||
29 | Checkboxes in compare view allow users to view combined compare view. You can |
|
29 | Checkboxes in compare view allow users to view combined compare view. You can | |
30 | only show the range between the first and last checkbox (no cherry pick). |
|
30 | only show the range between the first and last checkbox (no cherry pick). | |
@@ -38,7 +38,7 b' one changeset' | |||||
38 |
|
38 | |||
39 |
|
39 | |||
40 | Mailing |
|
40 | Mailing | |
41 | +++++++ |
|
41 | ------- | |
42 |
|
42 | |||
43 | When administrator will fill up the mailing settings in .ini files |
|
43 | When administrator will fill up the mailing settings in .ini files | |
44 | RhodeCode will send mails on user registration, or when RhodeCode errors occur |
|
44 | RhodeCode will send mails on user registration, or when RhodeCode errors occur | |
@@ -46,7 +46,7 b' on errors the mails will have a detailed' | |||||
46 |
|
46 | |||
47 |
|
47 | |||
48 | Trending source files |
|
48 | Trending source files | |
49 | +++++++++++++++++++++ |
|
49 | --------------------- | |
50 |
|
50 | |||
51 | Trending source files are calculated based on pre defined dict of known |
|
51 | Trending source files are calculated based on pre defined dict of known | |
52 | types and extensions. If You miss some extension or Would like to scan some |
|
52 | types and extensions. If You miss some extension or Would like to scan some |
@@ -10,7 +10,7 b' cached inside db and are gathered increm' | |||||
10 | this: |
|
10 | this: | |
11 |
|
11 | |||
12 | With Celery disabled |
|
12 | With Celery disabled | |
13 | ++++++++++++++++++++ |
|
13 | -------------------- | |
14 |
|
14 | |||
15 | - On each first visit to the summary page a set of 250 commits are parsed and |
|
15 | - On each first visit to the summary page a set of 250 commits are parsed and | |
16 | updates statistics cache. |
|
16 | updates statistics cache. | |
@@ -21,7 +21,7 b' With Celery disabled' | |||||
21 |
|
21 | |||
22 |
|
22 | |||
23 | With Celery enabled |
|
23 | With Celery enabled | |
24 | +++++++++++++++++++ |
|
24 | ------------------- | |
25 |
|
25 | |||
26 | - On the first visit to the summary page RhodeCode will create tasks that will |
|
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 |
|
27 | execute on celery workers. This task will gather all of the stats until all |
General Comments 0
You need to be logged in to leave comments.
Login now