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