Docs updates

README.rst

@@ -1,179 +1,179 b''
 =========
 RhodeCode
 =========
 
 About
 -----
 
 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ 
-with a built in push/pull server and full text search and code-review.
+with a built in push/pull server, full text search and code-review.
 It works on http/https and has a built in permission/authentication system with 
 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides
 simple API so it's easy integrable with existing external systems.
 
 RhodeCode is similar in some respects to github_ or bitbucket_, 
 however RhodeCode can be run as standalone hosted application on your own server.
 It is open source and donation ware and focuses more on providing a customized, 
 self administered interface for Mercurial_ and GIT_  repositories. 
 RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library 
 that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple 
 different version control systems.
 
 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
 
 Installation
 ------------
 Stable releases of RhodeCode are best installed via::
 
     easy_install rhodecode
 
 Or::
 
     pip install rhodecode 
 
 Detailed instructions and links may be found on the Installation page.
 
 Please visit http://packages.python.org/RhodeCode/installation.html for
 more details
 
 RhodeCode demo
 --------------
 
 http://demo.rhodecode.org
 
 The default access is anonymous but you can login to an administrative account
 using the following credentials:
 
 - username: demo
 - password: demo12
 
 Source code
 -----------
 
 The latest sources can be obtained from official RhodeCode instance
 https://secure.rhodecode.org 
 
 
 MIRRORS:
 
 Issue tracker and sources at bitbucket_
 
 http://bitbucket.org/marcinkuzminski/rhodecode
 
 Sources at github_
 
 https://github.com/marcinkuzminski/rhodecode
 
 
 RhodeCode Features
 ------------------
 
 - Has its own middleware to handle mercurial_ and git_ protocol requests. 
   Each request is authenticated and logged together with IP address.
 - Build for speed and performance. You can make multiple pulls/pushes simultaneous.
   Proven to work with 1000s of repositories and users
 - Supports http/https, LDAP, AD, proxy-pass authentication.
 - Full permissions (private/read/write/admin) together with IP restrictions for each repository,
   additional explicit forking and repository creation permissions.
 - Users groups for easier permission management
 - Repository groups let you group repos and manage them easier.
 - Users can fork other users repos, and compare them at any time.
 - Integrates easily with other systems, with custom created mappers you can connect it to almost
   any issue tracker, and with an JSON-RPC API you can make much more
 - Build in commit-api let's you add, edit and commit files right from RhodeCode
   web interface using simple editor or upload binary files using simple form.
 - Powerfull pull-request driven review system with inline commenting,
   changeset statuses, and notification system.
 - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and  SVN.
 - Mako templates let's you customize the look and feel of the application.
 - Beautiful diffs, annotations and source code browsing all colored by pygments. 
   Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches
 - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics
   to track activity for repositories
 - Admin interface with user/permission management. Admin activity journal, logs
   pulls, pushes, forks, registrations and other actions made by all users.
 - Server side forks. It is possible to fork a project and modify it freely 
   without breaking the main repository.
 - rst and markdown README support for repositories. 
 - Full text search powered by Whoosh on the source files, commit messages, and file names.
   Build in indexing daemons, with optional incremental index build
   (no external search servers required all in one application)
 - Setup project descriptions/tags and info inside built in db for easy, non 
   file-system operations.
 - Intelligent cache with invalidation after push or project change, provides 
   high performance and always up to date data.
 - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz
 - Optional async tasks for speed and performance using celery_  
 - Backup scripts can do backup of whole app and send it over scp to desired 
   location 
 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
 
     
 Incoming / Plans
 ----------------
 
 - Finer granular permissions per branch, or subrepo
 - Web based merges for pull requests
 - Tracking history for each lines in files
 - Simple issue tracker 
 - SSH based authentication with server side key management
 - Commit based built in wiki system
 - Gist server
 - More statistics and graph (global annotation + some more statistics)
 - Other advancements as development continues (or you can of course make 
   additions and or requests)
 
 License
 -------
 
 ``RhodeCode`` is released under the GPLv3 license.
 
 
 Getting help
 ------------
 
 Listed bellow are various support resources that should help.
 
 .. note::
    
    Please try to read the documentation before posting any issues, especially
    the **troubleshooting section**
  
 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask
   any questions.
 
 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
 
 - Join #rhodecode on FreeNode (irc.freenode.net)
   or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
 
 - You can also follow me on twitter **@marcinkuzminski** where i often post some
   news about RhodeCode
 
 
 Online documentation
 --------------------
 
 Online documentation for the current version of RhodeCode is available at
  - http://packages.python.org/RhodeCode/
  - http://rhodecode.readthedocs.org/en/latest/index.html
 
 You may also build the documentation for yourself - go into ``docs/`` and run::
 
    make html
 
 (You need to have sphinx_ installed to build the documentation. If you don't
 have sphinx_ installed you can install it via the command: 
 ``easy_install sphinx``)
  
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _sphinx: http://sphinx.pocoo.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _bitbucket: http://bitbucket.org/
 .. _github: http://github.com/
 .. _subversion: http://subversion.tigris.org/
 .. _git: http://git-scm.com/
 .. _celery: http://celeryproject.org/
 .. _Sphinx: http://sphinx.pocoo.org/
-.. _vcs: http://pypi.python.org/pypi/vcs
  No newline at end of file
+.. _vcs: http://pypi.python.org/pypi/vcs

docs/changelog.rst

@@ -1,935 +1,955 b''
 .. _changelog:
 
 =========
 Changelog
 =========
 
+1.5.3 (**2013-02-12**)
+----------------------
+
+news
+++++
+
+- IP restrictions now also enabled for IPv6
+
+fixes
++++++
+
+- fixed issues with private checkbox not always working
+- fixed #746 unicodeDedode errors on feed controllers
+- fixes issue #756 cleanup repos didn't properly compose paths of repos to be cleaned up.
+- fixed cache invalidation issues together with vcs_full_cache option
+- repo scan should skip directories with starting with '.'
+- fixes for issue #731, update-repoinfo sometimes failed to update data when changesets
+  were initial commits
+- recursive mode of setting permission skips private repositories
+
 1.5.2 (**2013-01-14**)
 ----------------------
 
 news
 ++++
 
 - IP restrictions for users. Each user can get a set of whitelist IP+mask for
   extra protection. Useful for buildbots etc.
 - added full last changeset info to lightweight dashboard. lightweight dashboard
   is now fully functional replacement of original dashboard.
 - implemented certain API calls for non-admin users.
 - enabled all Markdown Extra plugins
 - implemented #725 Pull Request View - Show origin repo URL
 - show comments from pull requests into associated changesets
 
 fixes
 +++++
 
 - update repoinfo script is more failsafe
 - fixed #687  Lazy loaded tooltip bug with simultaneous ajax requests
 - fixed #691: Notifications for pull requests: move link to top for better
   readability
 - fixed #699: fix missing fork docs for API
 - fixed #693 Opening changeset from pull request fails
 - fixed #710 File view stripping empty lines from beginning and end of file
 - fixed issues with getting repos by path on windows, caused GIT hooks to fail
 - fixed issues with groups paginator on main dashboard
 - improved fetch/pull command for git repos, now pulling all refs
 - fixed issue #719 Journal revision ID tooltip AJAX query path is incorrect
   when running in a subdir
 - fixed issue #702 API methods without arguments fail when "args":null
 - set the status of changesets initially on pull request. Fixes issues #690 and #587
 
 1.5.1 (**2012-12-13**)
 ----------------------
 
 news
 ++++
 
 - implements #677: Don't allow to close pull requests when they are 
   under-review status
 - implemented #670 Implementation of Roles in Pull Request
 
 fixes
 +++++
 
 - default permissions can get duplicated after migration
 - fixed changeset status labels, they now select radio buttons
 - #682 translation difficult for multi-line text
 - #683 fixed difference between messages about not mapped repositories
 
 1.5.0 (**2012-12-12**)
 ----------------------
 
 news
 ++++
 
 - new rewritten from scratch diff engine. 10x faster in edge cases. Handling
   of file renames, copies, change flags and binary files
 - added lightweight dashboard option. ref #500. New version of dashboard
   page that doesn't use any VCS data and is super fast to render. Recommended
   for large amount of repositories.
 - implements #648 write Script for updating last modification time for
   lightweight dashboard
 - implemented compare engine for git repositories.
 - LDAP failover, option to specify multiple servers
 - added Errormator and Sentry support for monitoring RhodeCode
 - implemented #628: Pass server URL to rc-extensions hooks
 - new tooltip implementation - added lazy loading of changesets from journal
   pages. This can significantly improve speed of rendering the page
 - implements #632,added branch/tag/bookmarks info into feeds
   added changeset link to body of message
 - implemented #638 permissions overview to groups
 - implements #636, lazy loading of history and authors to speed up source
   pages rendering
 - implemented #647, option to pass list of default encoding used to 
   encode to/decode from unicode
 - added caching layer into RSS/ATOM feeds.
 - basic implementation of cherry picking changesets for pull request, ref #575
 - implemented #661 Add option to include diff in RSS feed
 - implemented file history page for showing detailed changelog for a given file
 - implemented #663 Admin/permission: specify default repogroup perms
 - implemented #379 defaults settings page for creation of repositories, locking
   statistics, downloads, repository type
 - implemented #210 filtering of admin journal based on Whoosh Query language
 - added parents/children links in changeset viewref #650
 
 fixes
 +++++
 
 - fixed git version checker
 - #586 patched basic auth handler to fix issues with git behind proxy
 - #589 search urlgenerator didn't properly escape special characters
 - fixed issue #614 Include repo name in delete confirmation dialog
 - fixed #623: Lang meta-tag doesn't work with C#/C++
 - fixes #612 Double quotes to Single quotes result in bad html in diff
 - fixes #630 git statistics do too much work making them slow.
 - fixes #625 Git-Tags are not displayed in Shortlog
 - fix for issue #602, enforce str when setting mercurial UI object. 
   When this is used together with mercurial internal translation system
   it can lead to UnicodeDecodeErrors
 - fixes #645 Fix git handler when doing delete remote branch
 - implements #649 added two seperate method for author and commiter to VCS
   changeset class switch author for git backed to be the real author not commiter
 - fix issue #504 RhodeCode is showing different versions of README on
   different summary page loads
 - implemented #658 Changing username in LDAP-Mode should not be allowed.
 - fixes #652 switch to generator approach when doing file annotation to prevent
   huge memory consumption 
 - fixes #666 move lockkey path location to cache_dir to ensure this path is
   always writable for rhodecode server
 - many more small fixes and improvements
 - fixed issues with recursive scans on removed repositories that could take
   long time on instance start
 
 1.4.4 (**2012-10-08**)
 ----------------------
 
 news
 ++++
 
 - obfuscate db password in logs for engine connection string
 - #574 Show pull request status also in shortlog (if any)
 - remember selected tab in my account page
 - Bumped mercurial version to 2.3.2
 - #595 rcextension hook for repository delete
 
 fixes
 +++++
 
 - Add git version detection to warn users that Git used in system is to
   old. Ref #588 - also show git version in system details in settings page
 - fixed files quick filter links
 - #590 Add GET flag that controls the way the diff are generated, for pull
   requests we want to use non-bundle based diffs, That are far better for
   doing code reviews. The /compare url still uses bundle compare for full
   comparison including the incoming changesets
 - Fixed #585, checks for status of revision where to strict, and made
   opening pull request with those revision impossible due to previously set
   status. Checks now are made also for the repository.
 - fixes #591 git backend was causing encoding errors when handling binary
   files - added a test case for VCS lib tests
 - fixed #597 commits in future get negative age.
 - fixed #598 API docs methods had wrong members parameter as returned data
 
 1.4.3 (**2012-09-28**)
 ----------------------
 
 news
 ++++
 
 - #558 Added config file to hooks extra data
 - bumped mercurial version to 2.3.1
 - #518 added possibility of specifying multiple patterns for issues
 - update codemirror to latest version
 
 fixes
 +++++
 
 - fixed #570 explicit users group permissions can overwrite owner permissions
 - fixed #578 set proper PATH with current Python for Git
   hooks to execute within same Python as RhodeCode 
 - fixed issue with Git bare repos that ends with .git in name
 
 1.4.2 (**2012-09-12**)
 ----------------------
 
 news
 ++++
 
 - added option to menu to quick lock/unlock repository for users that have
   write access to
 - Implemented permissions for writing to repo
   groups. Now only write access to group allows to create a repostiory
   within that group
 - #565 Add support for {netloc} and {scheme} to alternative_gravatar_url
 - updated translation for zh_CN 
 
 fixes
 +++++
 
 - fixed visual permissions check on repos groups inside groups
 - fixed issues with non-ascii search terms in search, and indexers
 - fixed parsing of page number in GET parameters
 - fixed issues with generating pull-request overview for repos with
   bookmarks and tags, also preview doesn't loose chosen revision from
   select dropdown
 
 1.4.1 (**2012-09-07**)
 ----------------------
 
 news
 ++++
 
 - always put a comment about code-review status change even if user send
   empty data 
 - modified_on column saves repository update and it's going to be used
   later for light version of main page ref #500
 - pull request notifications send much nicer emails with details about pull
   request
 - #551 show breadcrumbs in summary view for repositories inside a group
 
 fixes
 +++++
 
 - fixed migrations of permissions that can lead to inconsistency.
   Some users sent feedback that after upgrading from older versions issues 
   with updating default permissions occurred. RhodeCode detects that now and
   resets default user permission to initial state if there is a need for that.
   Also forces users to set the default value for new forking permission. 
 - #535 improved apache wsgi example configuration in docs
 - fixes #550 mercurial repositories comparision failed when origin repo had
   additional not-common changesets
 - fixed status of code-review in preview windows of pull request
 - git forks were not initialized at bare repos
 - fixes #555 fixes issues with comparing non-related repositories
 - fixes #557 follower counter always counts up
 - fixed issue #560 require push ssl checkbox wasn't shown when option was
   enabled
 - fixed #559
 - fixed issue #559 fixed bug in routing that mapped repo names with <name>_<num> in name as
   if it was a request to url by repository ID
 
 1.4.0 (**2012-09-03**)
 ----------------------
 
 news
 ++++
  
 - new codereview system
 - email map, allowing users to have multiple email addresses mapped into
   their accounts
 - improved git-hook system. Now all actions for git are logged into journal
   including pushed revisions, user and IP address
 - changed setup-app into setup-rhodecode and added default options to it.
 - new git repos are created as bare now by default
 - #464 added links to groups in permission box
 - #465 mentions autocomplete inside comments boxes
 - #469 added --update-only option to whoosh to re-index only given list
   of repos in index 
 - rhodecode-api CLI client
 - new git http protocol replaced buggy dulwich implementation.
   Now based on pygrack & gitweb
 - Improved RSS/ATOM feeds. Discoverable by browsers using proper headers, and 
   reformated based on user suggestions. Additional rss/atom feeds for user
   journal
 - various i18n improvements
 - #478 permissions overview for admin in user edit view
 - File view now displays small gravatars off all authors of given file
 - Implemented landing revisions. Each repository will get landing_rev attribute
   that defines 'default' revision/branch for generating readme files
 - Implemented #509, RhodeCode enforces SSL for push/pulling if requested at 
   earliest possible call.
 - Import remote svn repositories to mercurial using hgsubversion.
 - Fixed #508 RhodeCode now has a option to explicitly set forking permissions
 - RhodeCode can use alternative server for generating avatar icons
 - implemented repositories locking. Pull locks, push unlocks. Also can be done
   via API calls
 - #538 form for permissions can handle multiple users at once 
 
 fixes
 +++++
 
 - improved translations
 - fixes issue #455 Creating an archive generates an exception on Windows
 - fixes #448 Download ZIP archive keeps file in /tmp open and results 
   in out of disk space
 - fixes issue #454 Search results under Windows include proceeding
   backslash
 - fixed issue #450. Rhodecode no longer will crash when bad revision is
   present in journal data.
 - fix for issue #417, git execution was broken on windows for certain
   commands.
 - fixed #413. Don't disable .git directory for bare repos on deleting
 - fixed issue #459. Changed the way of obtaining logger in reindex task.
 - fixed #453 added ID field in whoosh SCHEMA that solves the issue of
   reindexing modified files
 - fixed #481 rhodecode emails are sent without Date header 
 - fixed #458 wrong count when no repos are present
 - fixed issue #492 missing `\ No newline at end of file` test at the end of 
   new chunk in html diff
 - full text search now works also for commit messages
 
 1.3.6 (**2012-05-17**)
 ----------------------
 
 news
 ++++
 
 - chinese traditional translation
 - changed setup-app into setup-rhodecode and added arguments for auto-setup 
   mode that doesn't need user interaction 
 
 fixes
 +++++
 
 - fixed no scm found warning
 - fixed __future__ import error on rcextensions
 - made simplejson required lib for speedup on JSON encoding
 - fixes #449 bad regex could get more than revisions from parsing history
 - don't clear DB session when CELERY_EAGER is turned ON
 
 1.3.5 (**2012-05-10**)
 ----------------------
 
 news
 ++++
 
 - use ext_json for json module
 - unified annotation view with file source view
 - notification improvements, better inbox + css
 - #419 don't strip passwords for login forms, make rhodecode 
   more compatible with LDAP servers
 - Added HTTP_X_FORWARDED_FOR as another method of extracting 
   IP for pull/push logs. - moved all to base controller  
 - #415: Adding comment to changeset causes reload. 
   Comments are now added via ajax and doesn't reload the page
 - #374 LDAP config is discarded when LDAP can't be activated
 - limited push/pull operations are now logged for git in the journal
 - bumped mercurial to 2.2.X series
 - added support for displaying submodules in file-browser
 - #421 added bookmarks in changelog view
 
 fixes
 +++++
 
 - fixed dev-version marker for stable when served from source codes
 - fixed missing permission checks on show forks page
 - #418 cast to unicode fixes in notification objects
 - #426 fixed mention extracting regex
 - fixed remote-pulling for git remotes remopositories
 - fixed #434: Error when accessing files or changesets of a git repository 
   with submodules
 - fixed issue with empty APIKEYS for users after registration ref. #438
 - fixed issue with getting README files from git repositories
 
 1.3.4 (**2012-03-28**)
 ----------------------
 
 news
 ++++
 
 - Whoosh logging is now controlled by the .ini files logging setup
 - added clone-url into edit form on /settings page
 - added help text into repo add/edit forms
 - created rcextensions module with additional mappings (ref #322) and
   post push/pull/create repo hooks callbacks
 - implemented #377 Users view for his own permissions on account page
 - #399 added inheritance of permissions for users group on repos groups
 - #401 repository group is automatically pre-selected when adding repos 
   inside a repository group
 - added alternative HTTP 403 response when client failed to authenticate. Helps 
   solving issues with Mercurial and LDAP
 - #402 removed group prefix from repository name when listing repositories 
   inside a group
 - added gravatars into permission view and permissions autocomplete
 - #347 when running multiple RhodeCode instances, properly invalidates cache 
   for all registered servers
 
 fixes
 +++++
 
 - fixed #390 cache invalidation problems on repos inside group
 - fixed #385 clone by ID url was loosing proxy prefix in URL
 - fixed some unicode problems with waitress
 - fixed issue with escaping < and > in changeset commits
 - fixed error occurring during recursive group creation in API 
   create_repo function
 - fixed #393 py2.5 fixes for routes url generator
 - fixed #397 Private repository groups shows up before login
 - fixed #396 fixed problems with revoking users in nested groups
 - fixed mysql unicode issues + specified InnoDB as default engine with 
   utf8 charset
 - #406 trim long branch/tag names in changelog to not break UI
   
 1.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
 
 1.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
 
 1.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
 
 1.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
 
 1.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 
 
 1.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 
 
 1.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
 
 1.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
 
 1.2.1 (**2011-10-08**)
 ----------------------
 
 news
 ++++
 
 
 fixes
 +++++
 
 - fixed problems with basic auth and push problems 
 - gui fixes
 - fixed logger
 
 1.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.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.1.7 (**2011-03-23**)
 ----------------------
 
 news
 ++++
 
 fixes
 +++++
 
 - fixed (again) #136 installation support for FreeBSD
 
 
 1.1.6 (**2011-03-21**)
 ----------------------
 
 news
 ++++
 
 fixes
 +++++
 
 - fixed #136 installation support for FreeBSD
 - RhodeCode will check for python version during installation
 
 1.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
 - cleaned out docs, big thanks to Jason Harris
 
 1.1.4 (**2011-02-19**)
 ----------------------
 
 news
 ++++
 
 fixes
 +++++
 
 - fixed formencode import problem on settings page, that caused server crash
   when that page was accessed as first after server start
 - journal fixes
 - fixed option to access repository just by entering http://server/<repo_name> 
 
 1.1.3 (**2011-02-16**)
 ----------------------
 
 news
 ++++
 
 - implemented #102 allowing the '.' character in username
 - added option to access repository just by entering http://server/<repo_name>
 - celery task ignores result for better performance
 
 fixes
 +++++
 
 - fixed ehlo command and non auth mail servers on smtp_lib. Thanks to 
   apollo13 and Johan Walles
 - small fixes in journal
 - fixed problems with getting setting for celery from .ini files
 - registration, password reset and login boxes share the same title as main 
   application now
 - fixed #113: to high permissions to fork repository
 - fixed problem with '[' chars in commit messages in journal
 - removed issue with space inside renamed repository after deletion
 - db transaction fixes when filesystem repository creation failed
 - fixed #106 relation issues on databases different than sqlite
 - fixed static files paths links to use of url() method
 
 1.1.2 (**2011-01-12**)
 ----------------------
 
 news
 ++++
 
 
 fixes
 +++++
 
 - fixes #98 protection against float division of percentage stats
 - fixed graph bug
 - forced webhelpers version since it was making troubles during installation 
 
 1.1.1 (**2011-01-06**)
 ----------------------
  
 news
 ++++
 
 - added force https option into ini files for easier https usage (no need to
   set server headers with this options)
 - small css updates
 
 fixes
 +++++
 
 - fixed #96 redirect loop on files view on repositories without changesets
 - fixed #97 unicode string passed into server header in special cases (mod_wsgi)
   and server crashed with errors
 - fixed large tooltips problems on main page
 - fixed #92 whoosh indexer is more error proof
 
 1.1.0 (**2010-12-18**)
 ----------------------
 
 news
 ++++
 
 - rewrite of internals for vcs >=0.1.10
 - uses mercurial 1.7 with dotencode disabled for maintaining compatibility 
   with older clients
 - anonymous access, authentication via ldap
 - performance upgrade for cached repos list - each repository has its own 
   cache that's invalidated when needed.
 - performance upgrades on repositories with large amount of commits (20K+)
 - main page quick filter for filtering repositories
 - user dashboards with ability to follow chosen repositories actions
 - sends email to admin on new user registration
 - added cache/statistics reset options into repository settings
 - more detailed action logger (based on hooks) with pushed changesets lists
   and options to disable those hooks from admin panel
 - introduced new enhanced changelog for merges that shows more accurate results
 - new improved and faster code stats (based on pygments lexers mapping tables, 
   showing up to 10 trending sources for each repository. Additionally stats
   can be disabled in repository settings.
 - gui optimizations, fixed application width to 1024px
 - added cut off (for large files/changesets) limit into config files
 - whoosh, celeryd, upgrade moved to paster command
 - other than sqlite database backends can be used
 
 fixes
 +++++
 
 - fixes #61 forked repo was showing only after cache expired
 - fixes #76 no confirmation on user deletes
 - fixes #66 Name field misspelled
 - fixes #72 block user removal when he owns repositories
 - fixes #69 added password confirmation fields
 - fixes #87 RhodeCode crashes occasionally on updating repository owner
 - fixes #82 broken annotations on files with more than 1 blank line at the end
 - a lot of fixes and tweaks for file browser
 - fixed detached session issues
 - fixed when user had no repos he would see all repos listed in my account
 - fixed ui() instance bug when global hgrc settings was loaded for server 
   instance and all hgrc options were merged with our db ui() object
 - numerous small bugfixes
  
 (special thanks for TkSoh for detailed feedback)
 
 
 1.0.2 (**2010-11-12**)
 ----------------------
 
 news
 ++++
 
 - tested under python2.7
 - bumped sqlalchemy and celery versions
 
 fixes
 +++++
 
 - fixed #59 missing graph.js
 - fixed repo_size crash when repository had broken symlinks
 - fixed python2.5 crashes.
 
 
 1.0.1 (**2010-11-10**)
 ----------------------
 
 news
 ++++
 
 - small css updated
 
 fixes
 +++++
 
 - fixed #53 python2.5 incompatible enumerate calls
 - fixed #52 disable mercurial extension for web
 - fixed #51 deleting repositories don't delete it's dependent objects
 
 
 1.0.0 (**2010-11-02**)
 ----------------------
 
 - security bugfix simplehg wasn't checking for permissions on commands
   other than pull or push.
 - fixed doubled messages after push or pull in admin journal
 - templating and css corrections, fixed repo switcher on chrome, updated titles
 - admin menu accessible from options menu on repository view
 - permissions cached queries
 
 1.0.0rc4  (**2010-10-12**)
 --------------------------
 
 - fixed python2.5 missing simplejson imports (thanks to Jens Bäckman)
 - removed cache_manager settings from sqlalchemy meta
 - added sqlalchemy cache settings to ini files
 - validated password length and added second try of failure on paster setup-app
 - fixed setup database destroy prompt even when there was no db
 
 
 1.0.0rc3 (**2010-10-11**)
 -------------------------
 
 - fixed i18n during installation.
 
 1.0.0rc2 (**2010-10-11**)
 -------------------------
 
 - Disabled dirsize in file browser, it's causing nasty bug when dir renames 
   occure. After vcs is fixed it'll be put back again.
-- templating/css rewrites, optimized css.
  No newline at end of file
+- templating/css rewrites, optimized css.

docs/installation_win.rst

@@ -1,250 +1,292 b''
 .. _installation_win:
 
 
 Step by step Installation for Windows
 =====================================
 
 
 RhodeCode step-by-step install Guide for Windows  
 
 Target OS: Windows XP SP3 32bit English (Clean installation) 
 + All Windows Updates until 24-may-2012 
 
 .. note::
     
    This installation is for 32bit systems, for 64bit windows you might need
-   to download proper 64bit version of "Windows Installer" and Win32py
-   extensions
+   to download proper 64bit versions of the different packages(Windows Installer, Win32py extensions)
+   plus some extra tweaks.
+   These extra steps haven been marked as "64bit".
+   Tested on Windows Server 2008 R2 SP1, 9-feb-2013.
+   If you run into any 64bit related problems, please check these pages:
+   - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/
+   - http://bugs.python.org/issue7511
 
 Step1 - Install Visual Studio 2008 Express
 ------------------------------------------
 
  
 Optional: You can also install MingW, but VS2008 installation is easier 
 
 Download "Visual C++ 2008 Express Edition with SP1" from: 
 http://www.microsoft.com/visualstudio/en-us/products/2008-editions/express 
 (if not found or relocated, google for "visual studio 2008 express" for 
 updated link) 
 
 You can also download full ISO file for offline installation, just 
 choose "All - Offline Install ISO image file" in the previous page and 
 choose "Visual C++ 2008 Express" when installing. 
 
+.. note::
+
+   Using other versions of Visual Studio will lead to random crashes.
+   You must use Visual Studio 2008!"
 
 .. note::
 
   Silverlight Runtime and SQL Server 2008 Express Edition are not 
   required, you can uncheck them 
 
+.. note::
+   
+   64bit: You also need to install the Microsoft Windows SDK for .NET 3.5 SP1 (.NET 4.0 won't work).
+   Download from: http://www.microsoft.com/en-us/download/details.aspx?id=3138
+
+.. note::
+
+   64bit: You also need to copy and rename a .bat file to make the Visual C++ compiler work.
+   I am not sure why this is not necessary for 32bit.
+   Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
+
 
 Step2 - Install Python
 ----------------------
 
 Install Python 2.x.y (x >= 5) x86 version (32bit). DO NOT USE A 3.x version.
 Download Python 2.x.y from: 
 http://www.python.org/download/ 
 
 Choose "Windows Installer" (32bit version) not "Windows X86-64 
 Installer". While writing this guide, the latest version was v2.7.3. 
 Remember the specific major and minor version installed, because it will 
 be needed in the next step. In this case, it is "2.7". 
 
+.. note::
+
+   64bit: Just download and install the 64bit version of python.
 
 Step3 - Install Win32py extensions
 ----------------------------------
  
 Download pywin32 from: 
 http://sourceforge.net/projects/pywin32/files/ 
 
 - Click on "pywin32" folder 
 - Click on the first folder (in this case, Build 217, maybe newer when you try) 
 - Choose the file ending with ".win32-py2.x.exe" -> x being the minor 
   version of Python you installed (in this case, 7) 
   When writing this guide, the file was: 
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20217/pywin32-217.win32-py2.7.exe/download 
 
+  .. note::
+
+     64bit: Download and install the 64bit version.
+     At the time of writing you can find this at: 
+     http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
 
 Step4 - Python BIN
 ------------------
 
 Add Python BIN folder to the path 
 
 You have to add the Python folder to the path, you can do it manually 
 (editing "PATH" environment variable) or using Windows Support Tools 
 that came preinstalled in Vista/7 and can be installed in Windows XP. 
 
 - Using support tools on WINDOWS XP: 
   If you use Windows XP you can install them using Windows XP CD and 
   navigating to \SUPPORT\TOOLS. There, execute Setup.EXE (not MSI). 
   Afterwards, open a CMD and type::
  
     SETX PATH "%PATH%;[your-python-path]" -M 
 
   Close CMD (the path variable will be updated then) 
 
 - Using support tools on WINDOWS Vista/7: 
 
   Open a CMD and type::
 
     SETX PATH "%PATH%;[your-python-path]" /M 
 
   Please substitute [your-python-path] with your Python installation path. 
   Typically: C:\\Python27 
 
 
 Step5 - RhodeCode folder structure
 ----------------------------------
 
 Create a RhodeCode folder structure 
 
 This is only a example to install RhodeCode, you can of course change 
 it. However, this guide will follow the proposed structure, so please 
 later adapt the paths if you change them. My recommendation is to use 
 folders with NO SPACES. But you can try if you are brave... 
 
 Create the following folder structure::
 
   C:\RhodeCode 
   C:\RhodeCode\Bin 
   C:\RhodeCode\Env 
   C:\RhodeCode\Repos 
 
 
 Step6 - Install virtualenv
 ---------------------------
 
 Install Virtual Env for Python 
 
 Navigate to: http://www.virtualenv.org/en/latest/index.html#installation 
 Right click on "virtualenv.py" file and choose "Save link as...". 
 Download to C:\\RhodeCode (or whatever you want) 
 (the file is located at 
 https://raw.github.com/pypa/virtualenv/master/virtualenv.py) 
 
 Create a virtual Python environment in C:\\RhodeCode\\Env (or similar). To 
 do so, open a CMD (Python Path should be included in Step3), navigate 
 where you downloaded "virtualenv.py", and write:: 
 
  python virtualenv.py C:\RhodeCode\Env 
 
 (--no-site-packages is now the default behaviour of virtualenv, no need 
 to include it) 
 
 
 Step7 - Install RhodeCode
 -------------------------
 
 Finally, install RhodeCode 
 
 Close previously opened command prompt/s, and open a Visual Studio 2008 
 Command Prompt (**IMPORTANT!!**). To do so, go to Start Menu, and then open 
 "Microsoft Visual C++ 2008 Express Edition" -> "Visual Studio Tools" -> 
 "Visual Studio 2008 Command Prompt" 
 
+.. note::
+
+   64bit: For 64bit you need to modify the shortcut that is used to start the
+   Visual Studio 2008 Command Prompt. Use right-mouse click to open properties.
+
+Change commandline from::
+
+%comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" x86
+
+to::
+
+%comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" amd64
+
+
 In that CMD (loaded with VS2008 PATHs) type::
  
   cd C:\RhodeCode\Env\Scripts (or similar) 
   activate 
 
 The prompt will change into "(Env) C:\\RhodeCode\\Env\\Scripts" or similar 
 (depending of your folder structure). Then type:: 
 
  pip install rhodecode 
 
 (long step, please wait until fully complete) 
 
 Some warnings will appear, don't worry as they are normal.
 
 
 Step8 - Configuring RhodeCode
 -----------------------------
 
 
 steps taken from http://packages.python.org/RhodeCode/setup.html 
 
 You have to use the same Visual Studio 2008 command prompt as Step7, so 
 if you closed it reopen it following the same commands (including the 
 "activate" one). When ready, just type::
  
   cd C:\RhodeCode\Bin 
   paster make-config RhodeCode production.ini 
 
 Then, you must edit production.ini to fit your needs (ip address, ip 
 port, mail settings, database, whatever). I recommend using NotePad++ 
 (free) or similar text editor, as it handles well the EndOfLine 
 character differences between Unix and Windows 
 (http://notepad-plus-plus.org/) 
 
 For the sake of simplicity lets run it with the default settings. After 
 your edits (if any), in the previous Command Prompt, type:: 
  
  paster setup-rhodecode production.ini 
 
 (this time a NEW database will be installed, you must follow a different 
 step to later UPGRADE to a newer RhodeCode version) 
 
 The script will ask you for confirmation about creating a NEW database, 
 answer yes (y) 
 The script will ask you for repository path, answer C:\\RhodeCode\\Repos 
 (or similar) 
 The script will ask you for admin username and password, answer "admin" 
 + "123456" (or whatever you want) 
 The script will ask you for admin mail, answer "[e-mail]" (or 
 whatever you want) 
 
 If you make some mistake and the script does not end, don't worry, start 
 it again. 
 
 
 Step9 - Running RhodeCode
 -------------------------
 
 
 In the previous command prompt, being in the C:\\RhodeCode\\Bin folder, 
 just type::
  
  paster serve production.ini 
 
 Open yout web server, and go to http://127.0.0.1:5000 
 
 It works!! :-) 
 
 Remark: 
 If it does not work first time, just Ctrl-C the CMD process and start it 
 again. Don't forget the "http://" in Internet Explorer 
 
 
 
 What this Guide does not cover:
 
 - Installing Celery 
 - Running RhodeCode as Windows Service. You can investigate here:
  
   - http://pypi.python.org/pypi/wsgisvc 
   - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/     
   - http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service 
 
 - Using Apache. You can investigate here:
 
   - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4 
 
 
 Upgrading
 =========
  
 Stop running RhodeCode 
 Open a CommandPrompt like in Step7 (VS2008 path + activate) and type::
  
  easy_install -U rhodecode 
  cd \RhodeCode\Bin 
 
 { backup your production.ini file now} :: 
 
  paster make-config RhodeCode production.ini 
 
 (check changes and update your production.ini accordingly) ::
  
  paster upgrade-db production.ini (update database)
 
-Full steps in http://packages.python.org/RhodeCode/upgrade.html 
  No newline at end of file
+Full steps in http://packages.python.org/RhodeCode/upgrade.html

docs/setup.rst

@@ -1,725 +1,735 b''
 .. _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 postgresql or sqlite (default). 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. RhodeCode currently supports
 postgresql, sqlite and mysql databases. Create the database by running
 the following command::
 
     paster setup-rhodecode 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-rhodecode`` will also prompt you for a username 
 and password for the initial admin account which ``setup-rhodecode`` sets 
 up for you.
 
 setup process can be fully automated, example for lazy::
 
     paster setup-rhodecode production.ini --user=marcink --password=secret --email=[e-mail] --repos=/home/marcink/my_repos
     
 
 - The ``setup-rhodecode`` 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 
   127.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-rhodecode`` 
   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
 
 Optionally users can create `rcextensions` package that extends RhodeCode
 functionality. To do this simply execute::
 
     paster make-rcext production.ini
 
 This will create `rcextensions` package in the same place that your `ini` file
 lives. With `rcextensions` it's possible to add additional mapping for whoosh, 
 stats and add additional code into the push/pull/create/delete repo hooks.
 For example for sending signals to build-bots such as jenkins.
 Please see the `__init__.py` file inside `rcextensions` package 
 for more details.
 
 
 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://[e-mail]/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. Can be also a comma separated
     list of servers to support LDAP fail-over.
 
 .. _Port:
 
 Port : required
     389 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
 from the ``X-Forwarded-User`` request header, which should be configured to be
 sent by the reverse-proxy server.
 
 After setting up your proxy solution (see `Apache virtual host reverse proxy example`_,
 `Apache as subdirectory`_ or `Nginx virtual host example`_), you'd need to
 configure the authentication and add the username in a request header named
 ``X-Forwarded-User``.
 
 For example, the following config section for Apache sets a subdirectory in a
 reverse-proxy setup with basic auth::
 
     <Location /<someprefix> >
       ProxyPass http://127.0.0.1:5000/<someprefix>
       ProxyPassReverse http://127.0.0.1:5000/<someprefix>
       SetEnvIf X-Url-Scheme https HTTPS=1
 
       AuthType Basic
       AuthName "RhodeCode authentication"
       AuthUserFile /home/web/rhodecode/.htpasswd
       require valid-user
 
       RequestHeader unset X-Forwarded-User
 
       RewriteEngine On
       RewriteCond %{LA-U:REMOTE_USER} (.+)
       RewriteRule .* - [E=RU:%1]
       RequestHeader set X-Forwarded-User %{RU}e
     </Location> 
 
 In order for RhodeCode to start using the forwarded username, you should set
 the following in the [app:main] section of your .ini file::
 
     proxypass_auth_enabled = true
 
 .. note::
    If you enable proxy pass-through authentication, make sure your server is
    only accessible through the proxy. Otherwise, any client would be able to
    forge the authentication header and could effectively become authenticated
    using any account of their liking.
 
 Integration with Issue trackers
 -------------------------------
 
 RhodeCode provides a simple integration with issue trackers. It's possible
 to define a regular expression that will fetch issue id stored in commit
 messages and replace that with an url to this issue. To enable this simply
 uncomment following variables in the ini file::
 
     url_pat = (?:^#|\s#)(\w+)
     issue_server_link = https://myissueserver.com/{repo}/issue/{id}
     issue_prefix = #
 
 `url_pat` is the regular expression that will fetch issues from commit messages.
 Default regex will match issues in format of #<number> eg. #300.
  
 Matched issues will be replace with the link specified as `issue_server_link` 
 {id} will be replaced with issue id, and {repo} with repository name.
 Since the # is striped `issue_prefix` is added as a prefix to url. 
 `issue_prefix` can be something different than # if you pass 
 ISSUE- as issue prefix this will generate an url in format::
  
   <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a>  
 
 Hook management
 ---------------
 
 Hooks can be managed in similar way to this used in .hgrc files.
 To access hooks setting click `advanced setup` on Hooks section of Mercurial
 Settings in Admin. 
 
 There are 4 built in hooks that cannot be changed (only enable/disable by
 checkboxes on previos section).
 To add another custom hook simply fill in first section with 
 <name>.<hook_type> and the second one with hook path. Example hooks
 can be found at *rhodecode.lib.hooks*. 
 
 
 Changing default encoding
 -------------------------
 
 By default RhodeCode uses utf8 encoding, starting from 1.3 series this
 can be changed, simply edit default_encoding in .ini file to desired one.
 This affects many parts in rhodecode including commiters names, filenames,
 encoding of commit messages. In addition RhodeCode can detect if `chardet`
 library is installed. If `chardet` is detected RhodeCode will fallback to it
 when there are encode/decode errors.
 
 
 Setting Up Celery
 -----------------
 
 Since version 1.1 celery is configured by the rhodecode ini configuration files.
 Simply set use_celery=true in the ini file then add / change the configuration 
 variables inside the ini file.
 
 Remember that the ini files use the format with '.' not with '_' like celery.
 So for example setting `BROKER_HOST` in celery means setting `broker.host` in
 the config file.
 
 In order to start using celery run::
 
  paster celeryd <configfile.ini>
 
 
 .. note::
    Make sure you run this command from the same virtualenv, and with the same 
    user that rhodecode runs.
    
 HTTPS support
 -------------
 
 There are two ways to enable https:
 
 - Set HTTP_X_URL_SCHEME in your http server headers, than rhodecode will
   recognize this headers and make proper https redirections
 - Alternatively, change the `force_https = true` flag in the ini configuration 
   to force using https, no headers are needed than to enable https
 
 
 Nginx virtual host example
 --------------------------
 
 Sample config for nginx using proxy::
 
     upstream rc {
         server 127.0.0.1:5000;
         # add more instances for load balancing
         #server 127.0.0.1:5001;
         #server 127.0.0.1:5002;
     }
     
     server {
-       listen          80;
-       server_name     hg.myserver.com;
+       listen          443;
+       server_name     rhodecode.myserver.com;
        access_log      /var/log/nginx/rhodecode.access.log;
        error_log       /var/log/nginx/rhodecode.error.log;
 
+       ssl on;
+       ssl_certificate     rhodecode.myserver.com.crt;
+       ssl_certificate_key rhodecode.myserver.com.key;
+
+       ssl_session_timeout 5m;
+
+       ssl_protocols SSLv3 TLSv1;
+       ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
+       ssl_prefer_server_ciphers on;
+
        # uncomment if you have nginx with chunking module compiled
        # fixes the issues of having to put postBuffer data for large git
        # pushes       
        #chunkin on;
        #error_page 411 = @my_411_error;
        #location @my_411_error {
        #    chunkin_resume;
        #}
        
        # uncomment if you want to serve static files by nginx
        #root /path/to/installation/rhodecode/public;
        
        location / {
             try_files $uri @rhode;
        }
     
        location @rhode {
             proxy_pass      http://rc;
             include         /etc/nginx/proxy.conf;
        }
 
     }  
   
 Here's the proxy.conf. It's tuned so it will not timeout on long
 pushes or large pushes::
     
     proxy_redirect              off;
     proxy_set_header            Host $host;
     proxy_set_header            X-Url-Scheme $scheme;
     proxy_set_header            X-Host $http_host;
     proxy_set_header            X-Real-IP $remote_addr;
     proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header            Proxy-host $proxy_host;
     client_max_body_size        400m;
     client_body_buffer_size     128k;
     proxy_buffering             off;
     proxy_connect_timeout       7200;
     proxy_send_timeout          7200;
     proxy_read_timeout          7200;
     proxy_buffers               8 32k;
  
 Also, when using root path with nginx you might set the static files to false
 in the production.ini file::
 
     [app:main]
       use = egg:rhodecode
       full_stack = true
       static_files = false
       lang=en
       cache_dir = %(here)s/data
 
 In order to not have the statics served by the application. This improves speed.
 
 
 Apache virtual host reverse proxy example
 -----------------------------------------
 
 Here is a sample configuration file for apache using proxy::
 
     <VirtualHost *:80>
             ServerName hg.myserver.com
             ServerAlias hg.myserver.com
     
             <Proxy *>
               Order allow,deny
               Allow from all
             </Proxy>
     
             #important !
             #Directive to properly generate url (clone url) for pylons
             ProxyPreserveHost On
     
             #rhodecode instance
             ProxyPass / http://127.0.0.1:5000/
             ProxyPassReverse / http://127.0.0.1:5000/
             
             #to enable https use line below
             #SetEnvIf X-Url-Scheme https HTTPS=1
             
     </VirtualHost> 
 
 
 Additional tutorial
 http://wiki.pylonshq.com/display/pylonscookbook/Apache+as+a+reverse+proxy+for+Pylons
 
 
 Apache as subdirectory
 ----------------------
 
 Apache subdirectory part::
 
     <Location /<someprefix> >
       ProxyPass http://127.0.0.1:5000/<someprefix>
       ProxyPassReverse http://127.0.0.1:5000/<someprefix>
       SetEnvIf X-Url-Scheme https HTTPS=1
     </Location> 
 
 Besides the regular apache setup you will need to add the following line
 into [app:main] section of your .ini file::
 
     filter-with = proxy-prefix
 
 Add the following at the end of the .ini file::
 
     [filter:proxy-prefix]
     use = egg:PasteDeploy#prefix
     prefix = /<someprefix> 
 
 
 then change <someprefix> into your choosen prefix
 
 Apache's WSGI config
 --------------------
 
 Alternatively, RhodeCode can be set up with Apache under mod_wsgi. For
 that, you'll need to:
 
 - Install mod_wsgi. If using a Debian-based distro, you can install
   the package libapache2-mod-wsgi::
 
     aptitude install libapache2-mod-wsgi
 
 - Enable mod_wsgi::
 
     a2enmod wsgi
 
 - Create a wsgi dispatch script, like the one below. Make sure you
   check the paths correctly point to where you installed RhodeCode
   and its Python Virtual Environment.
 - Enable the WSGIScriptAlias directive for the wsgi dispatch script,
   as in the following example. Once again, check the paths are
   correctly specified.
 
 Here is a sample excerpt from an Apache Virtual Host configuration file::
 
     WSGIDaemonProcess pylons \
         threads=4 \
         python-path=/home/web/rhodecode/pyenv/lib/python2.6/site-packages
     WSGIScriptAlias / /home/web/rhodecode/dispatch.wsgi
     WSGIPassAuthorization On
 
 .. note::
    when running apache as root please add: `user=www-data group=www-data` 
    into above configuration
 
 .. note::
-   RhodeCode cannot be runned in multiprocess mode in apache, make sure
-   you don't specify `processes=num` directive in the config
+   Running RhodeCode in multiprocess mode in apache is not supported,
+   make sure you don't specify `processes=num` directive in the config
 
 
 Example wsgi dispatch script::
 
     import os
     os.environ["HGENCODING"] = "UTF-8"
     os.environ['PYTHON_EGG_CACHE'] = '/home/web/rhodecode/.egg-cache'
     
     # sometimes it's needed to set the curent dir
     os.chdir('/home/web/rhodecode/') 
 
     import site
     site.addsitedir("/home/web/rhodecode/pyenv/lib/python2.6/site-packages")
     
     from paste.deploy import loadapp
     from paste.script.util.logging_config import fileConfig
 
     fileConfig('/home/web/rhodecode/production.ini')
     application = loadapp('config:/home/web/rhodecode/production.ini')
 
 Note: when using mod_wsgi you'll need to install the same version of
 Mercurial that's inside RhodeCode's virtualenv also on the system's Python
 environment.
 
 
 Other configuration files
 -------------------------
 
 Some example init.d scripts can be found in init.d directory::
 
   https://secure.rhodecode.org/rhodecode/files/beta/init.d
 
 .. _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/
 .. _python-ldap: http://www.python-ldap.org/
 .. _mercurial-server: http://www.lshift.net/mercurial-server.html
 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories
 .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues
-.. _google group rhodecode: http://groups.google.com/group/rhodecode
  No newline at end of file
+.. _google group rhodecode: http://groups.google.com/group/rhodecode

docs/upgrade.rst

@@ -1,99 +1,107 b''
 .. _upgrade:
 
 =======
 Upgrade
 =======
 
 Upgrading from PyPI (aka "Cheeseshop")
 ---------------------------------------
 
 .. note::
    Firstly, it is recommended that you **always** perform a database and 
    configuration backup before doing an upgrade.
    
    (These directions will use '{version}' to note that this is the version of 
    Rhodecode that these files were used with.  If backing up your RhodeCode 
    instance from version 1.3.6 to 1.4.0, the ``production.ini`` file would be 
    backed up to ``production.ini.1-3-6``.)
 
 
 If using a sqlite database, stop the Rhodecode process/daemon/service, and
 then make a copy of the database file::
 
  service rhodecode stop
  cp rhodecode.db rhodecode.db.{version}
 
 
 Back up your configuration file::
 
  cp production.ini production.ini.{version}
 
 
 Ensure that you are using the Python Virtual Environment that you'd originally
 installed Rhodecode in::
 
  pip freeze
 
 will list all packages installed in the current environment.  If Rhodecode 
 isn't listed, change virtual environments to your venv location::
 
  source /opt/rhodecode-venv/bin/activate
 
 
 Once you have verified the environment you can upgrade ``Rhodecode`` with::
 
  easy_install -U rhodecode
 
 Or::
 
  pip install --upgrade rhodecode
 
 
 Then 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 recommended 
 that you 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.
 
+
+.. note::
+   DB schema upgrade library has some limitations and can sometimes fail if you try to
+   upgrade from older major releases. In such case simply run upgrades sequentially, eg.
+   upgrading from 1.2.X to 1.5.X should be done like that: 1.2.X. > 1.3.X > 1.4.X > 1.5.X
+   You can always specify what version of RhodeCode you want to install for example in pip
+   `pip install RhodeCode==1.3.6`
+
 You may find it helpful to clear out your log file so that new errors are 
 readily apparent::
 
  echo > rhodecode.log
 
 Once that is complete, you may now start your upgraded Rhodecode Instance::
 
  service rhodecode start
 
 Or::
 
  paster serve /var/www/rhodecode/production.ini
 
 .. note::
    If you're using Celery, make sure you restart all instances of it after
    upgrade.
 
 .. _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/

docs/usage/general.rst

@@ -1,107 +1,115 b''
 .. _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)
+from the repository name, and internal repository storage (.hg/.git). There
+is also a special command for cleaning such archived repos::
+
+    paster cleanup-repos --older-than=30d production.ini
+
+This command will scan for archived repositories that are older than 30d,
+display them and ask if you want to delete them (there's a --dont-ask flag also)
+If you host big amount of repositories with forks that are constantly deleted
+it's recommended that you run such command via crontab.
 
 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. In this view also it's possible to switch to combined compare.
 
 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.
 
 
 Mails are also sent for code comments. If someone comments on a changeset
 mail is sent to all participants, the person who commited the changeset 
 (if present in RhodeCode), and to all people mentioned with @mention system.
 
 
 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`
 
 
 Cloning remote repositories
 ---------------------------
 
 RhodeCode has an ability to clone remote repos from given remote locations.
 Currently it support following options:
 
 - hg  -> hg clone
 - svn -> hg clone
 - git -> git clone
 
 
 .. note::
     
-    - *`svn -> hg` cloning requires `hgsubversion` library to be installed.*
+    * `svn -> hg` cloning requires `hgsubversion` library to be installed.*
 
 If you need to clone repositories that are protected via basic auth, you
 might pass the url with stored credentials inside eg. 
-`http://user:[e-mail]/repo, RhodeCode will try to login and clone
+`http://user:[e-mail]/repo`, RhodeCode will try to login and clone
 using given credentials. Please take a note that they will be stored as
 plaintext inside the database. RhodeCode will remove auth info when showing the 
 clone url in summary page.

docs/usage/troubleshooting.rst

@@ -1,70 +1,82 b''
 .. _troubleshooting:
 
 
 ===============
 Troubleshooting
 ===============
 
 :Q: **Missing static files?**
 :A: Make sure either to set the `static_files = true` in the .ini file or
    double check the root path for your http setup. It should point to 
    for example:
    /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public
    
 | 
 
 :Q: **Can't install celery/rabbitmq?**
 :A: Don't worry RhodeCode works without them too. No extra setup is required.
     Try out great celery docs for further help.
 
 |
  
 :Q: **Long lasting push timeouts?**
 :A: Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts
     are caused by https server and not RhodeCode.
     
 | 
 
 :Q: **Large pushes timeouts?**
 :A: Make sure you set a proper max_body_size for the http server. Very often
     Apache, Nginx or other http servers kill the connection due to to large
     body.
 
 |
 
 :Q: **Apache doesn't pass basicAuth on pull/push?**
 :A: Make sure you added `WSGIPassAuthorization true`.
 
 |
 
 :Q: **Git fails on push/pull?**
 :A: Make sure you're using an wsgi http server that can handle chunked encoding
     such as `waitress` or `gunicorn`
 
 |
 
 :Q: **How i use hooks in RhodeCode?**
 :A: It's easy if they are python hooks just use advanced link in hooks section
     in Admin panel, that works only for Mercurial. If you want to use githooks,
     just install proper one in repository eg. create file in 
     `/gitrepo/hooks/pre-receive`. You can also use RhodeCode-extensions to
     connect to callback hooks, for both Git and Mercurial.
 
 |
 
 :Q: **RhodeCode is slow for me, how can i make it faster?**
 :A: See the :ref:`performance` section
 
+|
+
+:Q: **UnicodeDecodeError on Apache mod_wsgi**
+:A: Please read: https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/modwsgi/#if-you-get-a-unicodeencodeerror
+
+|
+
+:Q: **Requests hanging on Windows**
+:A: Please try out with disabled Antivirus software, there are some known problems with Eset Anitivirus. Make sure
+    you have installed latest windows patches (especially KB2789397)
+
+
 For further questions search the `Issues tracker`_, or post a message in the 
 `google group rhodecode`_
 
 .. _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/
 .. _python-ldap: http://www.python-ldap.org/
 .. _mercurial-server: http://www.lshift.net/mercurial-server.html
 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories
 .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues
-.. _google group rhodecode: http://groups.google.com/group/rhodecode
  No newline at end of file
+.. _google group rhodecode: http://groups.google.com/group/rhodecode