##// END OF EJS Templates
docs update
marcink -
r642:674ecf21 beta
parent child Browse files
Show More
@@ -0,0 +1,32 b''
1 .. _upgrade:
2
3 Upgrade
4 =======
5
6 Upgrade from Cheese Shop
7 ------------------------
8
9 Easiest way to upgrade ``rhodecode`` is to run::
10
11 easy_install -U rhodecode
12
13 Or::
14
15 pip install --upgrade rhodecode
16
17
18 Then make sure You run from the installation directory
19
20 ::
21
22 paster make-config RhodeCode production.ini
23
24 This will display any changes made from new version of RhodeCode To your
25 current config. And tries to do an automerge.
26
27
28 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
29 .. _python: http://www.python.org/
30 .. _mercurial: http://mercurial.selenic.com/
31 .. _celery: http://celeryproject.org/
32 .. _rabbitmq: http://www.rabbitmq.com/ No newline at end of file
@@ -1,42 +1,44 b''
1 .. _changelog:
1 .. _changelog:
2
2
3 Changelog
3 Changelog
4 =========
4 =========
5
5
6 1.1.0 (**XXXX-XX-XX**)
6 1.1.0 (**2010-XX-XX**)
7 ----------------------
7 ----------------------
8 - git support
8 - git support
9 - rewrite of internals for vcs >=0.1.9
9 - performance upgrade for cached repos list
10 - performance upgrade for cached repos list
11 - gui optimizations
12 - main page quick filter for filtering repositories
10
13
11
14 1.0.0 (**2010-11-02**)
12 1.0.0 (**2010-10-xx**)
13 ----------------------
15 ----------------------
14
16
15 - security bugfix simplehg wasn't checking for permissions on commands
17 - security bugfix simplehg wasn't checking for permissions on commands
16 other than pull or push.
18 other than pull or push.
17 - fixed doubled messages after push or pull in admin journal
19 - fixed doubled messages after push or pull in admin journal
18 - templating and css corrections, fixed repo switcher on chrome,updated titles
20 - templating and css corrections, fixed repo switcher on chrome, updated titles
19 - admin menu accessible from options menu on repository view
21 - admin menu accessible from options menu on repository view
20 - permissions cached queries
22 - permissions cached queries
21
23
22 1.0.0rc4 (**2010-10-12**)
24 1.0.0rc4 (**2010-10-12**)
23 --------------------------
25 --------------------------
24
26
25 - fixed python2.5 missing simplejson imports (thanks to Jens BΓ€ckman)
27 - fixed python2.5 missing simplejson imports (thanks to Jens BΓ€ckman)
26 - removed cache_manager settings from sqlalchemy meta
28 - removed cache_manager settings from sqlalchemy meta
27 - added sqlalchemy cache settings to ini files
29 - added sqlalchemy cache settings to ini files
28 - validated password length and added second try of failure on paster setup-app
30 - validated password length and added second try of failure on paster setup-app
29 - fixed setup database destroy prompt even when there was no db
31 - fixed setup database destroy prompt even when there was no db
30
32
31
33
32 1.0.0rc3 (**2010-10-11**)
34 1.0.0rc3 (**2010-10-11**)
33 -------------------------
35 -------------------------
34
36
35 - fixed i18n during installation.
37 - fixed i18n during installation.
36
38
37 1.0.0rc2 (**2010-10-11**)
39 1.0.0rc2 (**2010-10-11**)
38 -------------------------
40 -------------------------
39
41
40 - Disabled dirsize in file browser, it's causing nasty bug when dir renames
42 - Disabled dirsize in file browser, it's causing nasty bug when dir renames
41 occure. After vcs is fixed it'll be put back again.
43 occure. After vcs is fixed it'll be put back again.
42 - templating/css rewrites, optimized css.
44 - templating/css rewrites, optimized css.
@@ -1,119 +1,122 b''
1 .. _index:
1 .. _index:
2
2
3 Welcome to RhodeCode (RhodiumCode) documentation!
3 Welcome to RhodeCode (RhodiumCode) documentation!
4 =================================================
4 =================================================
5
5
6 ``RhodeCode`` (formerly hg-app) is Pylons based repository management and
6 ``RhodeCode`` (formerly hg-app) is Pylons based repository management and
7 serving for mercurial_. It's similar to github or bitbucket, but it's suppose to run
7 serving for mercurial_ and git_. It's similar to github or bitbucket, but
8 as standalone app, it's open source and focuses more on restricted access to repositories
8 it's suppose to run as standalone app, it's open source and focuses more on
9 There's no default free access to RhodeCode You have to create an account in order
9 restricted access to repositories. There's no default free access to RhodeCode
10 to use the application. It's powered by vcs_ library that we created to handle
10 You have to create an account in order to use the application. It's powered
11 many various version control systems.
11 by vcs_ library that we created to handle many various version control systems.
12
12
13 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
13 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
14
14
15
16 RhodeCode demo
15 RhodeCode demo
17 --------------
16 --------------
18
17
19 http://hg.python-works.com
18 http://hg.python-works.com
20
19
21 The default access is
20 The default access is
22
21
23 - username: demo
22 - username: demo
24 - password: demo
23 - password: demo
25
24
26 Source code
25 Source code
27 -----------
26 -----------
28
27
29 Source code is along with issue tracker is available at
28 Source code is along with issue tracker is available at
30 http://bitbucket.org/marcinkuzminski/rhodecode
29 http://bitbucket.org/marcinkuzminski/rhodecode
31
30
32 Also a source codes can be obtained from demo rhodecode instance
31 Also a source codes can be obtained from demo RhodeCode instance
33 http://hg.python-works.com/rhodecode/summary
32 http://hg.python-works.com/rhodecode/summary
34
33
35 Features
34 Features
36 --------
35 --------
37
36
38 - Has it's own middleware to handle mercurial_ protocol request. Each request
37 - Has it's own middleware to handle mercurial_ and git_ protocol request.
39 can be logged and authenticated. Runs on threads unlikely to hgweb You can
38 Each request can be logged and authenticated. Runs on threads unlikely to
40 make multiple pulls/pushes simultaneous. Supports http/https
39 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https
40 both on git_ and mercurial_
41 - Full permissions and authentication per project private/read/write/admin.
41 - Full permissions and authentication per project private/read/write/admin.
42 One account for web interface and mercurial_ push/pull/clone.
42 One account for web interface and mercurial_ push/pull/clone.
43 - Mako templates let's you customize look and feel of application.
43 - Mako templates let's you customize look and feel of application.
44 - Beautiful diffs, annotations and source codes all colored by pygments.
44 - Beautiful diffs, annotations and source codes all colored by pygments.
45 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
45 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
46 - Admin interface with user/permission management. User activity journal logs
46 - Admin interface with user/permission management. User activity journal logs
47 pulls, pushes, forks,registrations. Possible to disable built in hooks
47 pulls, pushes, forks,registrations. Possible to disable built in hooks
48 - Server side forks, it's possible to fork a project and hack it free without
48 - Server side forks, it's possible to fork a project and hack it free without
49 breaking the main.
49 breaking the main.
50 - Full text search on source codes, search on file names. All powered by whoosh
50 - Full text search on source codes, search on file names. All powered by whoosh
51 and build in indexing daemons
51 and build in indexing daemons
52 (no external search servers required all in one application)
52 (no external search servers required all in one application)
53 - Rss / atom feeds, gravatar support, download sources as zip/tarballs
53 - Rss / atom feeds, gravatar support, download sources as zip/tarballs
54 - Async tasks for speed and performance using celery_ (works without them too)
54 - Async tasks for speed and performance using celery_ (works without them too)
55 - Backup scripts can do backup of whole app and send it over scp to desired
55 - Backup scripts can do backup of whole app and send it over scp to desired
56 location
56 location
57 - Setup project descriptions and info inside built in db for easy, non
57 - Setup project descriptions and info inside built in db for easy, non
58 file-system operations
58 file-system operations
59 - Added cache with invalidation on push/repo management for high performance and
59 - Added cache with invalidation on push/repo management for high performance and
60 always up to date data.
60 always up to date data.
61 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
61 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
62
62
63
63
64 .. figure:: images/screenshot1_main_page.png
64 .. figure:: images/screenshot1_main_page.png
65 :align: left
65 :align: left
66
66
67 Main page of RhodeCode
67 Main page of RhodeCode
68
68
69 .. figure:: images/screenshot2_summary_page.png
69 .. figure:: images/screenshot2_summary_page.png
70 :align: left
70 :align: left
71
71
72 Summary page
72 Summary page
73
73
74
74
75 Incoming
75 Incoming
76 --------
76 --------
77
77
78 - code review (probably based on hg-review)
78 - code review (probably based on hg-review)
79 - full git_ support, with push/pull server
79 - full git_ support, with push/pull server
80 - commit based build in wiki system
80 - commit based build in wiki system
81 - clone points and cloning from remote repositories into rhodecode
81 - clone points and cloning from remote repositories into rhodecode
82 (git_ and mercurial_)
82 (git_ and mercurial_)
83 - more statistics and graph (global annotation + some more statistics)
84 - user customized activity dashboards
83 - some cache optimizations
85 - some cache optimizations
84 - other cools stuff that i can figure out (or You can help me figure out)
86 - other cools stuff that i can figure out (or You can help me figure out)
85
87
86 License
88 License
87 -------
89 -------
88
90
89 ``rhodecode`` is released under GPL_ license.
91 ``rhodecode`` is released under GPL_ license.
90
92
91
93
92 Documentation
94 Documentation
93 -------------
95 -------------
94
96
95 **Installation:**
97 **Installation:**
96
98
97 .. toctree::
99 .. toctree::
98 :maxdepth: 1
100 :maxdepth: 1
99
101
100 installation
102 installation
103 upgrade
101 setup
104 setup
102 changelog
105 changelog
103
106
104 Other topics
107 Other topics
105 ------------
108 ------------
106
109
107 * :ref:`genindex`
110 * :ref:`genindex`
108 * :ref:`search`
111 * :ref:`search`
109
112
110 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
113 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
111 .. _python: http://www.python.org/
114 .. _python: http://www.python.org/
112 .. _django: http://www.djangoproject.com/
115 .. _django: http://www.djangoproject.com/
113 .. _mercurial: http://mercurial.selenic.com/
116 .. _mercurial: http://mercurial.selenic.com/
114 .. _subversion: http://subversion.tigris.org/
117 .. _subversion: http://subversion.tigris.org/
115 .. _git: http://git-scm.com/
118 .. _git: http://git-scm.com/
116 .. _celery: http://celeryproject.org/
119 .. _celery: http://celeryproject.org/
117 .. _Sphinx: http://sphinx.pocoo.org/
120 .. _Sphinx: http://sphinx.pocoo.org/
118 .. _GPL: http://www.gnu.org/licenses/gpl.html
121 .. _GPL: http://www.gnu.org/licenses/gpl.html
119 .. _vcs: http://pypi.python.org/pypi/vcs
122 .. _vcs: http://pypi.python.org/pypi/vcs
General Comments 0
You need to be logged in to leave comments. Login now