Changeset - 674ecf21de85
Parent rev.
Child rev.
[Not reviewed]
beta
0 2 1
Marcin Kuzminski - 15 years ago 2010-11-02 22:24:55
marcin@python-works.com
docs update
3 files changed with 51 insertions and 14 deletions:
docs/changelog.rst
6
4
docs/index.rst
13
10
docs/upgrade.rst
32
0 comments (0 inline, 0 general)
docs/changelog.rst
➞
Show inline comments
 
.. _changelog:
 

			




	
	
	
		
 
Changelog

			




	
	
	
		
 
=========

			




	
	
	
		
 

			




	
	
	
		
 
1.1.0 (**XXXX-XX-XX**)

			




	
	
	
		
 
1.1.0 (**2010-XX-XX**)

			




	
	
	
		
 
----------------------

			




	
	
	
		
 
- git support

			




	
	
	
		
 
- rewrite of internals for vcs >=0.1.9

			




	
	
	
		
 
- performance upgrade for cached repos list

			




	
	
	
		
 
- gui optimizations

			




	
	
	
		
 
- main page quick filter for filtering repositories

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
1.0.0 (**2010-10-xx**)

			




	
	
	
		
 
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

			




	
	
	
		
 
- 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.

			




        

    


    
    

    

        

                

                    docs/index.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
	
		
 
.. _index:

			




	
	
	
		
 

			




	
	
	
		
 
Welcome to RhodeCode (RhodiumCode) documentation!

			




	
	
	
		
 
=================================================

			




	
	
	
		
 

			




	
	
	
		
 
``RhodeCode`` (formerly hg-app) is Pylons based repository management and 

			




	
	
	
		
 
serving for mercurial_. It's similar to github or bitbucket, but it's suppose to run

			




	
	
	
		
 
as standalone app, it's open source and focuses more on restricted access to repositories

			




	
	
	
		
 
There's no default free access to RhodeCode You have to create an account in order

			




	
	
	
		
 
to use the application. It's powered by vcs_ library that we created to handle

			




	
	
	
		
 
many various version control systems.

			




	
	
	
		
 
serving for mercurial_ and git_. It's similar to github or bitbucket, but 

			




	
	
	
		
 
it's suppose to run as standalone app, it's open source and focuses more on 

			




	
	
	
		
 
restricted access to repositories. There's no default free access to RhodeCode 

			




	
	
	
		
 
You have to create an account in order to use the application. It's powered 

			




	
	
	
		
 
by vcs_ library that we created to handle many various version control systems.

			




	
	
	
		
 

			




	
	
	
		
 
RhodeCode uses `Semantic Versioning <http://semver.org/>`_

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
RhodeCode demo

			




	
	
	
		
 
--------------

			




	
	
	
		
 

			




	
	
	
		
 
http://hg.python-works.com

			




	
	
	
		
 

			




	
	
	
		
 
The default access is

			




	
	
	
		
 

			




	
	
	
		
 
- username: demo

			




	
	
	
		
 
- password: demo

			




	
	
	
		
 

			




	
	
	
		
 
Source code

			




	
	
	
		
 
-----------

			




	
	
	
		
 

			




	
	
	
		
 
Source code is along with issue tracker is available at

			




	
	
	
		
 
http://bitbucket.org/marcinkuzminski/rhodecode

			




	
	
	
		
 

			




	
	
	
		
 
Also a source codes can be obtained from demo rhodecode instance

			




	
	
	
		
 
Also a source codes can be obtained from demo RhodeCode instance

			




	
	
	
		
 
http://hg.python-works.com/rhodecode/summary

			




	
	
	
		
 

			




	
	
	
		
 
Features

			




	
	
	
		
 
--------

			




	
	
	
		
 

			




	
	
	
		
 
- Has it's own middleware to handle mercurial_ protocol request. Each request 

			




	
	
	
		
 
  can be logged and authenticated. Runs on threads unlikely to hgweb You can 

			




	
	
	
		
 
  make multiple pulls/pushes simultaneous. Supports http/https

			




	
	
	
		
 
- Has it's own middleware to handle mercurial_ and git_ protocol request. 

			




	
	
	
		
 
  Each request can be logged and authenticated. Runs on threads unlikely to 

			




	
	
	
		
 
  hgweb You can make multiple pulls/pushes simultaneous. Supports http/https

			




	
	
	
		
 
  both on git_ and mercurial_

			




	
	
	
		
 
- Full permissions and authentication per project private/read/write/admin. 

			




	
	
	
		
 
  One account for web interface and mercurial_ push/pull/clone.

			




	
	
	
		
 
- Mako templates let's you customize look and feel of application.

			




	
	
	
		
 
- Beautiful diffs, annotations and source codes all colored by pygments.

			




	
	
	
		
 
- Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics

			




	
	
	
		
 
- Admin interface with user/permission management. User activity journal logs

			




	
	
	
		
 
  pulls, pushes, forks,registrations. Possible to disable built in hooks

			




	
	
	
		
 
- Server side forks, it's possible to fork a project and hack it free without

			




	
	
	
		
 
  breaking the main.   

			




	
	
	
		
 
- Full text search on source codes, search on file names. All powered by whoosh

			




	
	
	
		
 
  and build in indexing daemons

			




	
	
	
		
 
  (no external search servers required all in one application)

			




	
	
	
		
 
- Rss / atom feeds, gravatar support, download sources as zip/tarballs  

			




	
	
	
		
 
- Async tasks for speed and performance using celery_ (works without them too)  

			




	
	
	
		
 
- Backup scripts can do backup of whole app and send it over scp to desired 

			




	
	
	
		
 
  location

			




	
	
	
		
 
- Setup project descriptions and info inside built in db for easy, non 

			




	
	
	
		
 
  file-system operations

			




	
	
	
		
 
- Added cache with invalidation on push/repo management for high performance and

			




	
	
	
		
 
  always up to date data. 

			




	
	
	
		
 
- Based on pylons 1.0 / sqlalchemy 0.6 / sqlite

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
.. figure::  images/screenshot1_main_page.png

			




	
	
	
		
 
   :align:   left

			




	
	
	
		
 

			




	
	
	
		
 
   Main page of RhodeCode

			




	
	
	
		
 

			




	
	
	
		
 
.. figure::  images/screenshot2_summary_page.png

			




	
	
	
		
 
   :align:   left

			




	
	
	
		
 

			




	
	
	
		
 
   Summary page

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Incoming

			




	
	
	
		
 
--------

			




	
	
	
		
 

			




	
	
	
		
 
- code review (probably based on hg-review)

			




	
	
	
		
 
- full git_ support, with push/pull server

			




	
	
	
		
 
- commit based build in wiki system

			




	
	
	
		
 
- clone points and cloning from remote repositories into rhodecode 

			




	
	
	
		
 
  (git_ and mercurial_)

			




	
	
	
		
 
- more statistics and graph (global annotation + some more statistics)

			




	
	
	
		
 
- user customized activity dashboards

			




	
	
	
		
 
- some cache optimizations

			




	
	
	
		
 
- other cools stuff that i can figure out (or You can help me figure out)

			




	
	
	
		
 

			




	
	
	
		
 
License

			




	
	
	
		
 
-------

			




	
	
	
		
 

			




	
	
	
		
 
``rhodecode`` is released under GPL_ license.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Documentation

			




	
	
	
		
 
-------------

			




	
	
	
		
 

			




	
	
	
		
 
**Installation:**

			




	
	
	
		
 

			




	
	
	
		
 
.. toctree::

			




	
	
	
		
 
   :maxdepth: 1

			




	
	
	
		
 

			




	
	
	
		
 
   installation

			




	
	
	
		
 
   upgrade

			




	
	
	
		
 
   setup

			




	
	
	
		
 
   changelog

			




	
	
	
		
 

			




	
	
	
		
 
Other topics

			




	
	
	
		
 
------------

			




	
	
	
		
 

			




	
	
	
		
 
* :ref:`genindex`

			




	
	
	
		
 
* :ref:`search`

			




	
	
	
		
 

			




	
	
	
		
 
.. _virtualenv: http://pypi.python.org/pypi/virtualenv

			




	
	
	
		
 
.. _python: http://www.python.org/

			




	
	
	
		
 
.. _django: http://www.djangoproject.com/

			




	
	
	
		
 
.. _mercurial: http://mercurial.selenic.com/

			




	
	
	
		
 
.. _subversion: http://subversion.tigris.org/

			




	
	
	
		
 
.. _git: http://git-scm.com/

			




	
	
	
		
 
.. _celery: http://celeryproject.org/

			




	
	
	
		
 
.. _Sphinx: http://sphinx.pocoo.org/

			




	
	
	
		
 
.. _GPL: http://www.gnu.org/licenses/gpl.html

			




	
	
	
		
 
.. _vcs: http://pypi.python.org/pypi/vcs

			




        

    


    
    

    

        

                

                    docs/upgrade.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
new file 100644

			




	
	
	
		
 
.. _upgrade:

			




	
	
	
		
 

			




	
	
	
		
 
Upgrade

			




	
	
	
		
 
=======

			




	
	
	
		
 

			




	
	
	
		
 
Upgrade from Cheese Shop

			




	
	
	
		
 
------------------------

			




	
	
	
		
 

			




	
	
	
		
 
Easiest way to upgrade ``rhodecode`` is to run::

			




	
	
	
		
 

			




	
	
	
		
 
 easy_install -U rhodecode

			




	
	
	
		
 

			




	
	
	
		
 
Or::

			




	
	
	
		
 

			




	
	
	
		
 
 pip install --upgrade rhodecode

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Then make sure You run from the installation directory

			




	
	
	
		
 

			




	
	
	
		
 
::

			




	
	
	
		
 
 

			




	
	
	
		
 
 paster make-config RhodeCode production.ini

			




	
	
	
		
 
 

			




	
	
	
		
 
This will display any changes made from new version of RhodeCode To your

			




	
	
	
		
 
current config. And tries to do an automerge.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
.. _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

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2025 by various authors & licensed under GPLv3.