kallithea Changeset - 17c9393e9645

Changeset - 17c9393e9645

Parent rev.

Child rev.

[Not reviewed]

beta

0 11 0

Marcin Kuzminski - 14 years ago 2012-03-02 21:14:03
marcin@python-works.com

docs

11 files changed with 11 insertions and 2 deletions:

docs/api/api.rst

docs/api/models.rst

docs/changelog.rst

docs/contributing.rst

docs/installation.rst

docs/setup.rst

docs/upgrade.rst

docs/usage/backup.rst

docs/usage/general.rst

docs/usage/git_support.rst

docs/usage/statistics.rst

0 comments (0 inline, 0 general)

docs/api/api.rst

➞

Show inline comments

 .. _api:
+===
 API
 ===
 Starting from RhodeCode version 1.2 a simple API was implemented.
 There's a single schema for calling all api methods. API is implemented
 with JSON protocol both ways. An url to send API request in RhodeCode is
 <your_server>/_admin/api
 API ACCESS FOR WEB VIEWS
 ++++++++++++++++++++++++
 API access can also be turned on for each web view in RhodeCode that is
 decorated with `@LoginRequired` decorator. To enable API access simple change
 the standard login decorator to `@LoginRequired(api_access=True)`.
 After this change, a rhodecode view can be accessed without login by adding a
 GET parameter `?api_key=<api_key>` to url. By default this is only
 enabled on RSS/ATOM feed views.
 API ACCESS
 ++++++++++
 All clients are required to send JSON-RPC spec JSON data::
+    {
         "id:<id>,
         "api_key":"<api_key>",
         "method":"<method_name>",
         "args":{"<arg_key>":"<arg_val>"}
+    }
 Example call for autopulling remotes repos using curl::
     curl https://server.com/_admin/api -X POST -H 'content-type:text/plain' --data-binary '{"id":1,"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}'
 Simply provide
  - *id* A value of any type, which is used to match the response with the request that it is replying to.
  - *api_key* for access and permission validation.
  - *method* is name of method to call
  - *args* is an key:value list of arguments to pass to method
 .. note::
     api_key can be found in your user account page
 RhodeCode API will return always a JSON-RPC response::
+    {
         "id":<id>,
         "result": "<result>",
         "error": null
+    }
 All responses from API will be `HTTP/1.0 200 OK`, if there's an error while
 calling api *error* key from response will contain failure description
 and result will be null.
 API METHODS
 +++++++++++
 pull
 ----
 Pulls given repo from remote location. Can be used to automatically keep
 remote repos up to date. This command can be executed only using api_key
 belonging to user with admin rights
 INPUT::
     api_key : "<api_key>"
     method :  "pull"
     args :    {
                 "repo_name" : "<reponame>"
+              }
 OUTPUT::
     result : "Pulled from <reponame>"
     error :  null
 get_user
 --------
 Get's an user by username or user_id, Returns empty result if user is not found.
 This command can be executed only using api_key belonging to user with admin
 rights.
 INPUT::
     api_key : "<api_key>"
     method :  "get_user"
     args :    {
                 "userid" : "<username or user_id>"
+              }
 OUTPUT::
     result: None if user does not exist or
+            {
                 "id" :       "<id>",
                 "username" : "<username>",
                 "firstname": "<firstname>",
                 "lastname" : "<lastname>",
                 "email" :    "<email>",
                 "active" :   "<bool>",
                 "admin" :    "<bool>",
                 "ldap_dn" :  "<ldap_dn>"
+            }
     error:  null
 get_users
 ---------
 Lists all existing users. This command can be executed only using api_key
 belonging to user with admin rights.
 INPUT::
     api_key : "<api_key>"
     method :  "get_users"
     args :    { }
 OUTPUT::
     result: [
+              {
                 "id" :       "<id>",
                 "username" : "<username>",
                 "firstname": "<firstname>",
                 "lastname" : "<lastname>",
                 "email" :    "<email>",
                 "active" :   "<bool>",
                 "admin" :    "<bool>",
                 "ldap_dn" :  "<ldap_dn>"
               },
     	      …
+            ]
     error:  null
 create_user
 -----------
 Creates new user. This command can
 be executed only using api_key belonging to user with admin rights.
 INPUT::
     api_key : "<api_key>"
     method :  "create_user"
     args :    {
                 "username" :  "<username>",
                 "password" :  "<password>",
                 "email" :     "<useremail>",
                 "firstname" : "<firstname> = None",
                 "lastname" :  "<lastname> = None",
                 "active" :    "<bool> = True",
                 "admin" :     "<bool> = False",
                 "ldap_dn" :   "<ldap_dn> = None"
+              }
 OUTPUT::
     result: {
               "id" : "<new_user_id>",
               "msg" : "created new user <username>"
+            }
     error:  null
 update_user
 -----------
 updates current one if such user exists. This command can
 be executed only using api_key belonging to user with admin rights.
 INPUT::
     api_key : "<api_key>"
     method :  "update_user"
     args :    {
                 "userid" : "<user_id or username>",
                 "username" :  "<username>",
                 "password" :  "<password>",
                 "email" :     "<useremail>",
                 "firstname" : "<firstname>",
                 "lastname" :  "<lastname>",
                 "active" :    "<bool>",
                 "admin" :     "<bool>",
                 "ldap_dn" :   "<ldap_dn>"
+              }
 OUTPUT::
     result: {
               "id" : "<edited_user_id>",
               "msg" : "updated user <username>"
+            }
     error:  null
 get_users_group
 ---------------
 Gets an existing users group. This command can be executed only using api_key
 belonging to user with admin rights.
 INPUT::
     api_key : "<api_key>"
     method :  "get_users_group"
     args :    {
                 "group_name" : "<name>"
+              }
 OUTPUT::
     result : None if group not exist
+             {
                "id" :         "<id>",
                "group_name" : "<groupname>",
                "active":      "<bool>",
                "members" :  [
                               { "id" :       "<userid>",
                                 "username" : "<username>",
                                 "firstname": "<firstname>",
                                 "lastname" : "<lastname>",
                                 "email" :    "<email>",
                                 "active" :   "<bool>",
                                 "admin" :    "<bool>",
                                 "ldap" :     "<ldap_dn>"
                               },
                               …
+                            ]
+             }
     error : null
 get_users_groups
 ----------------
 Lists all existing users groups. This command can be executed only using
 api_key belonging to user with admin rights.
 INPUT::
     api_key : "<api_key>"
     method :  "get_users_groups"
     args :    { }
 OUTPUT::
     result : [
+               {
                  "id" :         "<id>",
                  "group_name" : "<groupname>",
                  "active":      "<bool>",
                  "members" :  [
+	    	                    {
 	    	                      "id" :       "<userid>",
 	                              "username" : "<username>",
 	                              "firstname": "<firstname>",
 	                              "lastname" : "<lastname>",
 	                              "email" :    "<email>",
 	                              "active" :   "<bool>",
 	                              "admin" :    "<bool>",
 	                              "ldap" :     "<ldap_dn>"
 	                            },
 	    	                    …
+	                          ]
+	            }
+              ]
     error : null
 create_users_group
 ------------------
 Creates new users group. This command can be executed only using api_key
 belonging to user with admin rights
 INPUT::
     api_key : "<api_key>"
     method :  "create_users_group"
     args:     {
                 "group_name":  "<groupname>",
                 "active":"<bool> = True"
+              }
 OUTPUT::
     result: {
               "id":  "<newusersgroupid>",
               "msg": "created new users group <groupname>"
+            }
     error:  null
 add_user_to_users_group
 -----------------------
 Adds a user to a users group. If user exists in that group success will be
 `false`. This command can be executed only using api_key
 belonging to user with admin rights
 INPUT::
     api_key : "<api_key>"
     method :  "add_user_users_group"
     args:     {
                 "group_name" :  "<groupname>",
                 "username" :   "<username>"
+              }
 OUTPUT::
     result: {
               "id":  "<newusersgroupmemberid>",
               "success": True|False # depends on if member is in group
               "msg": "added member <username> to users group <groupname> |
                       User is already in that group"
+            }
     error:  null
 remove_user_from_users_group
 ----------------------------
 Removes a user from a users group. If user is not in given group success will
 be `false`. This command can be executed only
 using api_key belonging to user with admin rights
 INPUT::
     api_key : "<api_key>"
     method :  "remove_user_from_users_group"
     args:     {
                 "group_name" :  "<groupname>",
                 "username" :   "<username>"
+              }
 OUTPUT::
     result: {
               "success":  True|False,  # depends on if member is in group
               "msg": "removed member <username> from users group <groupname> |
                       User wasn't in group"
+            }
     error:  null
 get_repo
 --------
 Gets an existing repository by it's name or repository_id. This command can
 be executed only using api_key belonging to user with admin rights.
 INPUT::
     api_key : "<api_key>"
     method :  "get_repo"
     args:     {
                 "repoid" : "<reponame or repo_id>"
+              }
 OUTPUT::
     result: None if repository does not exist or

docs/api/models.rst

➞

Show inline comments

 .. _models:
 ========================
 The :mod:`models` Module
 ========================
 .. automodule:: rhodecode.model
    :members:
 .. automodule:: rhodecode.model.comment
    :members:
 .. automodule:: rhodecode.model.notification
    :members:
 .. automodule:: rhodecode.model.permission
    :members:
 .. automodule:: rhodecode.model.repo_permission
    :members:
 .. automodule:: rhodecode.model.repo
    :members:
 .. automodule:: rhodecode.model.repos_group
    :members:
 .. automodule:: rhodecode.model.scm
    :members:
 .. automodule:: rhodecode.model.user
    :members:
 .. automodule:: rhodecode.model.users_group
    :members:
@@ \ No newline at end of file @@

docs/changelog.rst

➞

Show inline comments

 .. _changelog:
 =========
 Changelog
 =========
 .3.4 (**2012-XX-XX**)
 ----------------------
 :status: in-progress
 :branch: beta
 news
 ++++
 fixes
 +++++
 .3.3 (**2012-03-02**)
 ----------------------
 news
 ++++
 fixes
 +++++
 - fixed some python2.5 compatibility issues
 - fixed issues with removed repos was accidentally added as groups, after
   full rescan of paths
 - fixes #376 Cannot edit user (using container auth)
 - fixes #378 Invalid image urls on changeset screen with proxy-prefix
   configuration
 - fixed initial sorting of repos inside repo group
 - fixes issue when user tried to resubmit same permission into user/user_groups
 - bumped beaker version that fixes #375 leap error bug
 - fixed raw_changeset for git. It was generated with hg patch headers
 - fixed vcs issue with last_changeset for filenodes
 - fixed missing commit after hook delete
 - fixed #372 issues with git operation detection that caused a security issue
   for git repos
 .3.2 (**2012-02-28**)
 ----------------------
 news
 ++++
 fixes
 +++++
 - fixed git protocol issues with repos-groups
 - fixed git remote repos validator that prevented from cloning remote git repos
 - fixes #370 ending slashes fixes for repo and groups
 - fixes #368 improved git-protocol detection to handle other clients
 - fixes #366 When Setting Repository Group To Blank Repo Group Wont Be
   Moved To Root
 - fixes #371 fixed issues with beaker/sqlalchemy and non-ascii cache keys
 - fixed #373 missing cascade drop on user_group_to_perm table
 .3.1 (**2012-02-27**)
 ----------------------
 news
 ++++
 fixes
 +++++
 - redirection loop occurs when remember-me wasn't checked during login
 - fixes issues with git blob history generation
 - don't fetch branch for git in file history dropdown. Causes unneeded slowness
 .3.0 (**2012-02-26**)
 ----------------------
 news
 ++++
 - code review, inspired by github code-comments
 - #215 rst and markdown README files support
 - #252 Container-based and proxy pass-through authentication support
 - #44 branch browser. Filtering of changelog by branches
 - mercurial bookmarks support
 - new hover top menu, optimized to add maximum size for important views
 - configurable clone url template with possibility to specify  protocol like
   ssh:// or http:// and also manually alter other parts of clone_url.
 - enabled largefiles extension by default
 - optimized summary file pages and saved a lot of unused space in them
 - #239 option to manually mark repository as fork
 - #320 mapping of commit authors to RhodeCode users
 - #304 hashes are displayed using monospace font
 - diff configuration, toggle white lines and context lines
 - #307 configurable diffs, whitespace toggle, increasing context lines
 - sorting on branches, tags and bookmarks using YUI datatable
 - improved file filter on files page
 - implements #330 api method for listing nodes ar particular revision
 - #73 added linking issues in commit messages to chosen issue tracker url
   based on user defined regular expression
 - added linking of changesets in commit messages
 - new compact changelog with expandable commit messages
 - firstname and lastname are optional in user creation
 - #348 added post-create repository hook
 - #212 global encoding settings is now configurable from .ini files
 - #227 added repository groups permissions
 - markdown gets codehilite extensions
 - new API methods, delete_repositories, grante/revoke permissions for groups
   and repos
 fixes
 +++++
 - rewrote dbsession management for atomic operations, and better error handling
 - fixed sorting of repo tables
 - #326 escape of special html entities in diffs
 - normalized user_name => username in api attributes
 - fixes #298 ldap created users with mixed case emails created conflicts
   on saving a form
 - fixes issue when owner of a repo couldn't revoke permissions for users
   and groups
 - fixes #271 rare JSON serialization problem with statistics
 - fixes #337 missing validation check for conflicting names of a group with a
   repositories group
 - #340 fixed session problem for mysql and celery tasks
 - fixed #331 RhodeCode mangles repository names if the a repository group
   contains the "full path" to the repositories
 - #355 RhodeCode doesn't store encrypted LDAP passwords
 .2.5 (**2012-01-28**)
 ----------------------
 news
 ++++
 fixes
 +++++
 - #340 Celery complains about MySQL server gone away, added session cleanup
   for celery tasks
 - #341 "scanning for repositories in None" log message during Rescan was missing
   a parameter
 - fixed creating archives with subrepos. Some hooks were triggered during that
   operation leading to crash.
 - fixed missing email in account page.
 - Reverted Mercurial to 2.0.1 for windows due to bug in Mercurial that makes
   forking on windows impossible
 .2.4 (**2012-01-19**)
 ----------------------
 news
 ++++
 - RhodeCode is bundled with mercurial series 2.0.X by default, with
   full support to largefiles extension. Enabled by default in new installations
 - #329 Ability to Add/Remove Groups to/from a Repository via AP
 - added requires.txt file with requirements
 fixes
 +++++
 - fixes db session issues with celery when emailing admins
 - #331 RhodeCode mangles repository names if the a repository group
   contains the "full path" to the repositories
 - #298 Conflicting e-mail addresses for LDAP and RhodeCode users
 - DB session cleanup after hg protocol operations, fixes issues with
   `mysql has gone away` errors
 - #333 doc fixes for get_repo api function
 - #271 rare JSON serialization problem with statistics enabled
 - #337 Fixes issues with validation of repository name conflicting with
   a group name. A proper message is now displayed.
 - #292 made ldap_dn in user edit readonly, to get rid of confusion that field
   doesn't work
 - #316 fixes issues with web description in hgrc files
 .2.3 (**2011-11-02**)
 ----------------------
 news
 ++++
 - added option to manage repos group for non admin users
 - added following API methods for get_users, create_user, get_users_groups,
   get_users_group, create_users_group, add_user_to_users_groups, get_repos,
   get_repo, create_repo, add_user_to_repo
 - implements #237 added password confirmation for my account
   and admin edit user.
 - implements #291 email notification for global events are now sent to all
   administrator users, and global config email.
 fixes
 +++++
 - added option for passing auth method for smtp mailer
 - #276 issue with adding a single user with id>10 to usergroups
 - #277 fixes windows LDAP settings in which missing values breaks the ldap auth
 - #288 fixes managing of repos in a group for non admin user
 .2.2 (**2011-10-17**)
 ----------------------
 news
 ++++
 - #226 repo groups are available by path instead of numerical id
 fixes
 +++++
 - #259 Groups with the same name but with different parent group
 - #260 Put repo in group, then move group to another group -> repo becomes unavailable
 - #258 RhodeCode 1.2 assumes egg folder is writable (lockfiles problems)
 - #265 ldap save fails sometimes on converting attributes to booleans,
   added getter and setter into model that will prevent from this on db model level
 - fixed problems with timestamps issues #251 and #213
 - fixes #266 RhodeCode allows to create repo with the same name and in
   the same parent as group
 - fixes #245 Rescan of the repositories on Windows
 - fixes #248 cannot edit repos inside a group on windows
 - fixes #219 forking problems on windows
 .2.1 (**2011-10-08**)
 ----------------------
 news
 ++++
 fixes
 +++++
 - fixed problems with basic auth and push problems
 - gui fixes
 - fixed logger
 .2.0 (**2011-10-07**)
 ----------------------
 news
 ++++
 - implemented #47 repository groups
 - implemented #89 Can setup google analytics code from settings menu
 - implemented #91 added nicer looking archive urls with more download options
   like tags, branches
 - implemented #44 into file browsing, and added follow branch option
 - implemented #84 downloads can be enabled/disabled for each repository
 - anonymous repository can be cloned without having to pass default:default
   into clone url
 - fixed #90 whoosh indexer can index chooses repositories passed in command
   line
 - extended journal with day aggregates and paging
 - implemented #107 source code lines highlight ranges
 - implemented #93 customizable changelog on combined revision ranges -
   equivalent of githubs compare view
 - implemented #108 extended and more powerful LDAP configuration
 - implemented #56 users groups
 - major code rewrites optimized codes for speed and memory usage
 - raw and diff downloads are now in git format
 - setup command checks for write access to given path
 - fixed many issues with international characters and unicode. It uses utf8
   decode with replace to provide less errors even with non utf8 encoded strings
 - #125 added API KEY access to feeds
 - #109 Repository can be created from external Mercurial link (aka. remote
   repository, and manually updated (via pull) from admin panel
 - beta git support - push/pull server + basic view for git repos
 - added followers page and forks page
 - server side file creation (with binary file upload interface)
   and edition with commits powered by codemirror
 - #111 file browser file finder, quick lookup files on whole file tree
 - added quick login sliding menu into main page
 - changelog uses lazy loading of affected files details, in some scenarios
   this can improve speed of changelog page dramatically especially for
   larger repositories.
 - implements #214 added support for downloading subrepos in download menu.
 - Added basic API for direct operations on rhodecode via JSON
 - Implemented advanced hook management
 fixes
 +++++
 - fixed file browser bug, when switching into given form revision the url was
   not changing
 - fixed propagation to error controller on simplehg and simplegit middlewares
 - fixed error when trying to make a download on empty repository
 - fixed problem with '[' chars in commit messages in journal
 - fixed #99 Unicode errors, on file node paths with non utf-8 characters
 - journal fork fixes
 - removed issue with space inside renamed repository after deletion
 - fixed strange issue on formencode imports
 - fixed #126 Deleting repository on Windows, rename used incompatible chars.
 - #150 fixes for errors on repositories mapped in db but corrupted in
   filesystem
 - fixed problem with ascendant characters in realm #181
 - fixed problem with sqlite file based database connection pool
 - whoosh indexer and code stats share the same dynamic extensions map
 - fixes #188 - relationship delete of repo_to_perm entry on user removal
 - fixes issue #189 Trending source files shows "show more" when no more exist
 - fixes issue #197 Relative paths for pidlocks
 - fixes issue #198 password will require only 3 chars now for login form
 - fixes issue #199 wrong redirection for non admin users after creating a repository
 - fixes issues #202, bad db constraint made impossible to attach same group
   more than one time. Affects only mysql/postgres
 - fixes #218 os.kill patch for windows was missing sig param
 - improved rendering of dag (they are not trimmed anymore when number of
   heads exceeds 5)
 .1.8 (**2011-04-12**)
 ----------------------
 news
 ++++
 - improved windows support
 fixes
 +++++
 - fixed #140 freeze of python dateutil library, since new version is python2.x
   incompatible
 - setup-app will check for write permission in given path
 - cleaned up license info issue #149
 - fixes for issues #137,#116 and problems with unicode and accented characters.
 - fixes crashes on gravatar, when passed in email as unicode
 - fixed tooltip flickering problems
 - fixed came_from redirection on windows
 - fixed logging modules, and sql formatters
 - windows fixes for os.kill issue #133
 - fixes path splitting for windows issues #148
 - fixed issue #143 wrong import on migration to 1.1.X
 - fixed problems with displaying binary files, thanks to Thomas Waldmann
 - removed name from archive files since it's breaking ui for long repo names
 - fixed issue with archive headers sent to browser, thanks to Thomas Waldmann
 - fixed compatibility for 1024px displays, and larger dpi settings, thanks to
   Thomas Waldmann
 - fixed issue #166 summary pager was skipping 10 revisions on second page
 .1.7 (**2011-03-23**)
 ----------------------
 news
 ++++
 fixes
 +++++
 - fixed (again) #136 installation support for FreeBSD
 .1.6 (**2011-03-21**)
 ----------------------
 news
 ++++
 fixes
 +++++
 - fixed #136 installation support for FreeBSD
 - RhodeCode will check for python version during installation
 .1.5 (**2011-03-17**)
 ----------------------
 news
 ++++
 - basic windows support, by exchanging pybcrypt into sha256 for windows only
   highly inspired by idea of mantis406
 fixes
 +++++
 - fixed sorting by author in main page
 - fixed crashes with diffs on binary files
 - fixed #131 problem with boolean values for LDAP
 - fixed #122 mysql problems thanks to striker69
 - fixed problem with errors on calling raw/raw_files/annotate functions
   with unknown revisions
 - fixed returned rawfiles attachment names with international character

docs/contributing.rst

➞

Show inline comments

 .. _contributing:
 =========================
 Contributing to RhodeCode
 =========================
 If you would like to contribute to RhodeCode, please contact me, any help is
 greatly appreciated!
 Could I request that you make your source contributions by first forking the
 RhodeCode repository on bitbucket_
 https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to
 your forked repository. Please post all fixes into **BETA** branch since your
 fix might be already fixed there and i try to merge all fixes from beta into
 stable, and not the other way. Finally, when you are finished making a change,
 please send me a pull request.
 To run RhodeCode in a development version you always need to install the latest
 required libs from `requires.txt` file.
 after downloading/pulling RhodeCode make sure you run::
     python setup.py develop
 command to install/verify all required packages, and prepare development
 enviroment.
 After finishing your changes make sure all tests passes ok. You can run
 the testsuite running nosetest from the project root.
 | Thank you for any contributions!
 |  Marcin
 .. _bitbucket: http://bitbucket.org/

docs/installation.rst

➞

Show inline comments

 .. _installation:
 ============
 Installation
 ============
 ``RhodeCode`` is written entirely in Python. Before posting any issues make
 sure, your not missing any system libraries and using right version of
 libraries required by RhodeCode. There's also restriction in terms of mercurial
 clients. Minimal version of hg client known working fine with RhodeCode is
 **1.6**. If you're using older client, please upgrade.
 Installing RhodeCode from Cheese Shop
 -------------------------------------
 Rhodecode requires python version 2.5 or higher.
 The easiest way to install ``rhodecode`` is to run::
     easy_install rhodecode
 Or::
     pip install rhodecode
 If you prefer to install RhodeCode manually simply grab latest release from
 http://pypi.python.org/pypi/rhodecode, decompress the archive and run::
     python setup.py install
 Step by step installation example
 ---------------------------------
 For installing RhodeCode i highly recommend using separate virtualenv_. This
 way many required by RhodeCode libraries will remain sandboxed from your main
 python and making things less problematic when doing system python updates.
 - Assuming you have installed virtualenv_ create a new virtual environment
   using virtualenv command::
     virtualenv --no-site-packages /var/www/rhodecode-venv
 .. note:: Using ``--no-site-packages`` when generating your
    virtualenv is **very important**. This flag provides the necessary
    isolation for running the set of packages required by
    RhodeCode.  If you do not specify ``--no-site-packages``,
    it's possible that RhodeCode will not install properly into
    the virtualenv, or, even if it does, may not run properly,
    depending on the packages you've already got installed into your
    Python's "main" site-packages dir.
 - this will install new virtualenv_ into `/var/www/rhodecode-venv`.
 - Activate the virtualenv_ by running::
     source /var/www/rhodecode-venv/bin/activate
 .. note:: If you're using UNIX, *do not* use ``sudo`` to run the
    ``virtualenv`` script.  It's perfectly acceptable (and desirable)
    to create a virtualenv as a normal user.
 - Make a folder for rhodecode data files, and configuration somewhere on the
   filesystem. For example::
     mkdir /var/www/rhodecode
 - Go into the created directory run this command to install rhodecode::
     easy_install rhodecode
   or::
     pip install rhodecode
 - This will install rhodecode together with pylons and all other required
   python libraries into activated virtualenv
 Requirements for Celery (optional)
 ----------------------------------
 In order to gain maximum performance
 there are some third-party you must install. When RhodeCode is used
 together with celery you have to install some kind of message broker,
 recommended one is rabbitmq_ to make the async tasks work.
 Of course RhodeCode works in sync mode also and then you do not have to install
 any third party applications. However, using Celery_ will give you a large
 speed improvement when using many big repositories. If you plan to use
 RhodeCode for say 7 to 10 repositories, RhodeCode will perform perfectly well
 without celery running.
 If you make the decision to run RhodeCode with celery make sure you run
 celeryd using paster and message broker together with the application.
 .. note::
    Installing message broker and using celery is optional, RhodeCode will
    work perfectly fine without them.
 **Message Broker**
 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
 - A possible alternative is `Redis <http://code.google.com/p/redis/>`_
 For installation instructions you can visit:
 http://ask.github.com/celery/getting-started/index.html.
 This is a very nice tutorial on how to start using celery_ with rabbitmq_
 You can now proceed to :ref:`setup`
 -----------------------------------
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _celery: http://celeryproject.org/
 .. _rabbitmq: http://www.rabbitmq.com/
@@ \ No newline at end of file @@

docs/setup.rst

➞

Show inline comments

 .. _setup:
 =====
 Setup
 =====
 Setting up RhodeCode
 --------------------
 First, you will need to create a RhodeCode configuration file. Run the
 following command to do this::
     paster make-config RhodeCode production.ini
 - This will create the file `production.ini` in the current directory. This
   configuration file contains the various settings for RhodeCode, e.g proxy
   port, email settings, usage of static files, cache, celery settings and
   logging.
 Next, you need to create the databases used by RhodeCode. I recommend that you
 use sqlite (default) or postgresql. If you choose a database other than the
 default ensure you properly adjust the db url in your production.ini
 configuration file to use this other database. Create the databases by running
 the following command::
     paster setup-app production.ini
 This will prompt you for a "root" path. This "root" path is the location where
 RhodeCode will store all of its repositories on the current machine. After
 entering this "root" path ``setup-app`` will also prompt you for a username
 and password for the initial admin account which ``setup-app`` sets up for you.
 - The ``setup-app`` command will create all of the needed tables and an admin
   account. When choosing a root path you can either use a new empty location,
   or a location which already contains existing repositories. If you choose a
   location which contains existing repositories RhodeCode will simply add all
   of the repositories at the chosen location to it's database. (Note: make
   sure you specify the correct path to the root).
 - Note: the given path for mercurial_ repositories **must** be write accessible
   for the application. It's very important since the RhodeCode web interface
   will work without write access, but when trying to do a push it will
   eventually fail with permission denied errors unless it has write access.
 You are now ready to use RhodeCode, to run it simply execute::
     paster serve production.ini
 - This command runs the RhodeCode server. The web app should be available at the
 .0.0.1:5000. This ip and port is configurable via the production.ini
   file created in previous step
 - Use the admin account you created above when running ``setup-app`` to login
   to the web app.
 - The default permissions on each repository is read, and the owner is admin.
   Remember to update these if needed.
 - In the admin panel you can toggle ldap, anonymous, permissions settings. As
   well as edit more advanced options on users and repositories
 Try copying your own mercurial repository into the "root" directory you are
 using, then from within the RhodeCode web application choose Admin >
 repositories. Then choose Add New Repository. Add the repository you copied
 into the root. Test that you can browse your repository from within RhodeCode
 and then try cloning your repository from RhodeCode with::
     hg clone http://127.0.0.1:5000/<repository name>
 where *repository name* is replaced by the name of your repository.
 Using RhodeCode with SSH
 ------------------------
 RhodeCode currently only hosts repositories using http and https. (The addition
 of ssh hosting is a planned future feature.) However you can easily use ssh in
 parallel with RhodeCode. (Repository access via ssh is a standard "out of
 the box" feature of mercurial_ and you can use this to access any of the
 repositories that RhodeCode is hosting. See PublishingRepositories_)
 RhodeCode repository structures are kept in directories with the same name
 as the project. When using repository groups, each group is a subdirectory.
 This allows you to easily use ssh for accessing repositories.
 In order to use ssh you need to make sure that your web-server and the users
 login accounts have the correct permissions set on the appropriate directories.
 (Note that these permissions are independent of any permissions you have set up
 using the RhodeCode web interface.)
 If your main directory (the same as set in RhodeCode settings) is for example
 set to **/home/hg** and the repository you are using is named `rhodecode`, then
 to clone via ssh you should run::
     hg clone ssh://user@server.com/home/hg/rhodecode
 Using other external tools such as mercurial-server_ or using ssh key based
 authentication is fully supported.
 Note: In an advanced setup, in order for your ssh access to use the same
 permissions as set up via the RhodeCode web interface, you can create an
 authentication hook to connect to the rhodecode db and runs check functions for
 permissions against that.
 Setting up Whoosh full text search
 ----------------------------------
 Starting from version 1.1 the whoosh index can be build by using the paster
 command ``make-index``. To use ``make-index`` you must specify the configuration
 file that stores the location of the index. You may specify the location of the
 repositories (`--repo-location`).  If not specified, this value is retrieved
 from the RhodeCode database.  This was required prior to 1.2.  Starting from
 version 1.2 it is also possible to specify a comma separated list of
 repositories (`--index-only`) to build index only on chooses repositories
 skipping any other found in repos location
 You may optionally pass the option `-f` to enable a full index rebuild. Without
 the `-f` option, indexing will run always in "incremental" mode.
 For an incremental index build use::
 	paster make-index production.ini
 For a full index rebuild use::
 	paster make-index production.ini -f
 building index just for chosen repositories is possible with such command::
  paster make-index production.ini --index-only=vcs,rhodecode
 In order to do periodical index builds and keep your index always up to date.
 It's recommended to do a crontab entry for incremental indexing.
 An example entry might look like this::
     /path/to/python/bin/paster make-index /path/to/rhodecode/production.ini
 When using incremental mode (the default) whoosh will check the last
 modification date of each file and add it to be reindexed if a newer file is
 available. The indexing daemon checks for any removed files and removes them
 from index.
 If you want to rebuild index from scratch, you can use the `-f` flag as above,
 or in the admin panel you can check `build from scratch` flag.
 Setting up LDAP support
 -----------------------
 RhodeCode starting from version 1.1 supports ldap authentication. In order
 to use LDAP, you have to install the python-ldap_ package. This package is
 available via pypi, so you can install it by running
 using easy_install::
     easy_install python-ldap
 using pip::
     pip install python-ldap
 .. note::
    python-ldap requires some certain libs on your system, so before installing
    it check that you have at least `openldap`, and `sasl` libraries.
 LDAP settings are located in admin->ldap section,
 Here's a typical ldap setup::
  Connection settings
  Enable LDAP          = checked
  Host                 = host.example.org
  Port                 = 389
  Account              = <account>
  Password             = <password>
  Connection Security  = LDAPS connection
  Certificate Checks   = DEMAND
  Search settings
  Base DN              = CN=users,DC=host,DC=example,DC=org
  LDAP Filter          = (&(objectClass=user)(!(objectClass=computer)))
  LDAP Search Scope    = SUBTREE
  Attribute mappings
  Login Attribute      = uid
  First Name Attribute = firstName
  Last Name Attribute  = lastName
  E-mail Attribute     = mail
 .. _enable_ldap:
 Enable LDAP : required
     Whether to use LDAP for authenticating users.
 .. _ldap_host:
 Host : required
     LDAP server hostname or IP address.
 .. _Port:
 Port : required
 for un-encrypted LDAP, 636 for SSL-encrypted LDAP.
 .. _ldap_account:
 Account : optional
     Only required if the LDAP server does not allow anonymous browsing of
     records.  This should be a special account for record browsing.  This
     will require `LDAP Password`_ below.
 .. _LDAP Password:
 Password : optional
     Only required if the LDAP server does not allow anonymous browsing of
     records.
 .. _Enable LDAPS:
 Connection Security : required
     Defines the connection to LDAP server
     No encryption
         Plain non encrypted connection
     LDAPS connection
         Enable ldaps connection. It will likely require `Port`_ to be set to
         a different value (standard LDAPS port is 636). When LDAPS is enabled
         then `Certificate Checks`_ is required.
     START_TLS on LDAP connection
         START TLS connection
 .. _Certificate Checks:
 Certificate Checks : optional
     How SSL certificates verification is handled - this is only useful when
     `Enable LDAPS`_ is enabled.  Only DEMAND or HARD offer full SSL security
     while the other options are susceptible to man-in-the-middle attacks.  SSL
     certificates can be installed to /etc/openldap/cacerts so that the
     DEMAND or HARD options can be used with self-signed certificates or
     certificates that do not have traceable certificates of authority.
     NEVER
         A serve certificate will never be requested or checked.
     ALLOW
         A server certificate is requested.  Failure to provide a
         certificate or providing a bad certificate will not terminate the
         session.
     TRY
         A server certificate is requested.  Failure to provide a
         certificate does not halt the session; providing a bad certificate
         halts the session.
     DEMAND
         A server certificate is requested and must be provided and
         authenticated for the session to proceed.
     HARD
         The same as DEMAND.
 .. _Base DN:
 Base DN : required
     The Distinguished Name (DN) where searches for users will be performed.
     Searches can be controlled by `LDAP Filter`_ and `LDAP Search Scope`_.
 .. _LDAP Filter:
 LDAP Filter : optional
     A LDAP filter defined by RFC 2254.  This is more useful when `LDAP
     Search Scope`_ is set to SUBTREE.  The filter is useful for limiting
     which LDAP objects are identified as representing Users for
     authentication.  The filter is augmented by `Login Attribute`_ below.
     This can commonly be left blank.
 .. _LDAP Search Scope:
 LDAP Search Scope : required
     This limits how far LDAP will search for a matching object.
     BASE
         Only allows searching of `Base DN`_ and is usually not what you
         want.
     ONELEVEL
         Searches all entries under `Base DN`_, but not Base DN itself.
     SUBTREE
         Searches all entries below `Base DN`_, but not Base DN itself.
         When using SUBTREE `LDAP Filter`_ is useful to limit object
         location.
 .. _Login Attribute:
 Login Attribute : required
     The LDAP record attribute that will be matched as the USERNAME or
     ACCOUNT used to connect to RhodeCode.  This will be added to `LDAP
     Filter`_ for locating the User object.  If `LDAP Filter`_ is specified as
     "LDAPFILTER", `Login Attribute`_ is specified as "uid" and the user has
     connected as "jsmith" then the `LDAP Filter`_ will be augmented as below
     ::
         (&(LDAPFILTER)(uid=jsmith))
 .. _ldap_attr_firstname:
 First Name Attribute : required
     The LDAP record attribute which represents the user's first name.
 .. _ldap_attr_lastname:
 Last Name Attribute : required
     The LDAP record attribute which represents the user's last name.
 .. _ldap_attr_email:
 Email Attribute : required
     The LDAP record attribute which represents the user's email address.
 If all data are entered correctly, and python-ldap_ is properly installed
 users should be granted access to RhodeCode with ldap accounts.  At this
 time user information is copied from LDAP into the RhodeCode user database.
 This means that updates of an LDAP user object may not be reflected as a
 user update in RhodeCode.
 If You have problems with LDAP access and believe You entered correct
 information check out the RhodeCode logs, any error messages sent from LDAP
 will be saved there.
 Active Directory
 ''''''''''''''''
 RhodeCode can use Microsoft Active Directory for user authentication.  This
 is done through an LDAP or LDAPS connection to Active Directory.  The
 following LDAP configuration settings are typical for using Active
 Directory ::
  Base DN              = OU=SBSUsers,OU=Users,OU=MyBusiness,DC=v3sys,DC=local
  Login Attribute      = sAMAccountName
  First Name Attribute = givenName
  Last Name Attribute  = sn
  E-mail Attribute     = mail
 All other LDAP settings will likely be site-specific and should be
 appropriately configured.
 Authentication by container or reverse-proxy
 --------------------------------------------
 Starting with version 1.3, RhodeCode supports delegating the authentication
 of users to its WSGI container, or to a reverse-proxy server through which all
 clients access the application.
 When these authentication methods are enabled in RhodeCode, it uses the
 username that the container/proxy (Apache/Nginx/etc) authenticated and doesn't
 perform the authentication itself. The authorization, however, is still done by
 RhodeCode according to its settings.
 When a user logs in for the first time using these authentication methods,
 a matching user account is created in RhodeCode with default permissions. An
 administrator can then modify it using RhodeCode's admin interface.
 It's also possible for an administrator to create accounts and configure their
 permissions before the user logs in for the first time.
 Container-based authentication
 ''''''''''''''''''''''''''''''
 In a container-based authentication setup, RhodeCode reads the user name from
 the ``REMOTE_USER`` server variable provided by the WSGI container.
 After setting up your container (see `Apache's WSGI config`_), you'd need
 to configure it to require authentication on the location configured for
 RhodeCode.
 In order for RhodeCode to start using the provided username, you should set the
 following in the [app:main] section of your .ini file::
     container_auth_enabled = true
 Proxy pass-through authentication
 '''''''''''''''''''''''''''''''''
 In a proxy pass-through authentication setup, RhodeCode reads the user name

docs/upgrade.rst

➞

Show inline comments

 .. _upgrade:
 =======
 Upgrade
 =======
 Upgrading from Cheese Shop
 --------------------------
 .. note::
    Firstly, it is recommended that you **always** perform a database backup
    before doing an upgrade.
 The easiest way to upgrade ``rhodecode`` is to run::
  easy_install -U rhodecode
 Or::
  pip install --upgrade rhodecode
 Then make sure you run the following command from the installation directory::
  paster make-config RhodeCode production.ini
 This will display any changes made by the new version of RhodeCode to your
 current configuration. It will try to perform an automerge. It's always better
 to make a backup of your configuration file before hand and re check the
 content after the automerge.
 .. note::
    Please always make sure your .ini files are up to date. Often errors are
    caused by missing params added in new versions.
 It is also recommended that you rebuild the whoosh index after upgrading since
 the new whoosh version could introduce some incompatible index changes. Please
 Read the changelog to see if there were any changes to whoosh.
 The final step is to upgrade the database. To do this simply run::
     paster upgrade-db production.ini
 This will upgrade the schema and update some of the defaults in the database,
 and will always recheck the settings of the application, if there are no new
 options that need to be set.
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _celery: http://celeryproject.org/
 .. _rabbitmq: http://www.rabbitmq.com/
@@ \ No newline at end of file @@

docs/usage/backup.rst

➞

Show inline comments

 .. _backup:
 ====================
 Backing up RhodeCode
 ====================
 Settings
 --------
 Just copy your .ini file, it contains all RhodeCode settings.
 Whoosh index
 ------------
 Whoosh index is located in **/data/index** directory where you installed
 RhodeCode ie. the same place where the ini file is located
 Database
 --------
 When using sqlite just copy rhodecode.db.
 Any other database engine requires a manual backup operation.
 Database backup will contain all gathered statistics
@@ \ No newline at end of file @@

docs/usage/general.rst

➞

Show inline comments

 .. _general:
 =======================
 General RhodeCode usage
 =======================
 Repository deleting
 -------------------
 Currently when admin/owner deletes a repository, RhodeCode does not physically
 delete a repository from filesystem, it renames it in a special way so it's
 not possible to push,clone or access repository. It's worth a notice that,
 even if someone will be given administrative access to RhodeCode and will
 delete a repository You can easy restore such action by restoring `rm__<date>`
 from the repository name, and internal repository storage (.hg/.git)
 Follow current branch in file view
 ----------------------------------
 In file view when this checkbox is checked the << and >> arrows will jump
 to changesets within the same branch currently viewing. So for example
 if someone is viewing files at 'beta' branch and marks `follow current branch`
 checkbox the << and >> buttons will only show him revisions for 'beta' branch
 Compare view from changelog
 ---------------------------
 Checkboxes in compare view allow users to view combined compare view. You can
 only show the range between the first and last checkbox (no cherry pick).
 Clicking more than one checkbox will activate a link in top saying
 `Show selected changes <from-rev> -> <to-rev>` clicking this will bring
 compare view
 Compare view is also available from the journal on pushes having more than
 one changeset
 Non changeable repository urls
 ------------------------------
 Due to complicated nature of repository grouping, often urls of repositories
 can change.
 example::
   #before
   http://server.com/repo_name
   # after insertion to test_group group the url will be
   http://server.com/test_group/repo_name
 This can be an issue for build systems and any other hardcoded scripts, moving
 repository to a group leads to a need for changing external systems. To
 overcome this RhodeCode introduces a non changable replacement url. It's
 simply an repository ID prefixed with `_` above urls are also accessible as::
   http://server.com/_<ID>
 Since ID are always the same moving the repository will not affect such url.
 the _<ID> syntax can be used anywhere in the system so urls with repo_name
 for changelogs, files and other can be exchanged with _<ID> syntax.
 Mailing
 -------
 When administrator will fill up the mailing settings in .ini files
 RhodeCode will send mails on user registration, or when RhodeCode errors occur
 on errors the mails will have a detailed traceback of error.
 Trending source files
 ---------------------
 Trending source files are calculated based on pre defined dict of known
 types and extensions. If You miss some extension or Would like to scan some
 custom files it's possible to add new types in `LANGUAGES_EXTENSIONS_MAP` dict
 located in `/rhodecode/lib/celerylib/tasks.py`
@@ \ No newline at end of file @@

docs/usage/git_support.rst

➞

Show inline comments

 .. _git_support:
 ===========
 GIT support
 ===========
 Git support in RhodeCode 1.3 was enabled by default.
 Although There are some limitations on git usage.
 - No hooks are runned for git push/pull actions.
 - logs in action journals don't have git operations
 - large pushes needs http server with chunked encoding support.
 if you plan to use git you need to run RhodeCode with some
 http server that supports chunked encoding which git http protocol uses,
 i recommend using waitress_ or gunicorn_ (linux only) for `paste` wsgi app
 replacement.
 To use waitress simply change change the following in the .ini file::
     use = egg:Paste#http
 To::
     use = egg:waitress#main
 And comment out bellow options::
     threadpool_workers =
     threadpool_max_requests =
     use_threadpool =
 You can simply run `paster serve` as usual.
 You can always disable git/hg support by editing a
 file **rhodecode/__init__.py** and commenting out backends
 .. code-block:: python
    BACKENDS = {
        'hg': 'Mercurial repository',
        #'git': 'Git repository',
+   }
 .. _waitress: http://pypi.python.org/pypi/waitress
 .. _gunicorn: http://pypi.python.org/pypi/gunicorn
@@ \ No newline at end of file @@

docs/usage/statistics.rst

➞

Show inline comments

 .. _statistics:
+==========
 Statistics
 ==========
 The RhodeCode statistics system makes heavy demands of the server resources, so
 in order to keep a balance between usability and performance, the statistics are
 cached inside db and are gathered incrementally, this is how RhodeCode does
 this:
 With Celery disabled
 --------------------
 - On each first visit to the summary page a set of 250 commits are parsed and
   updates statistics cache.
 - This happens on each single visit to the statistics page until all commits are
   fetched. Statistics are kept cached until additional commits are added to the
   repository. In such a case RhodeCode will only fetch the new commits when
   updating it's cache.
 With Celery enabled
 -------------------
 - On the first visit to the summary page RhodeCode will create tasks that will
   execute on celery workers. This task will gather all of the stats until all
   commits are parsed, each task will parse 250 commits, and run the next task to
   parse next 250 commits, until all of the commits are parsed.
 .. note::
    At any time you can disable statistics on each repository via the repository
    edit form in the admin panel. To do this just uncheck the statistics checkbox.

0 comments (0 inline, 0 general)