Mercurial > kallithea

annotate docs/index.rst @ 757:c52e88b57bf4 beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
rolled back to make transient since got some exceptions on expunge import fixups
author Marcin Kuzminski <marcin@python-works.com>
date Thu, 25 Nov 2010 21:57:25 +0100
parents 3389f272ece1
children 6e8322c438ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
1 .. _index:
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
2
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
3 Welcome to RhodeCode (RhodiumCode) documentation!
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
4 =================================================
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
5
717
9985eca2e4d0 updated docs and setup.py docs
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
6 ``RhodeCode`` (formerly hg-app) is Pylons based Mercurial repository
9985eca2e4d0 updated docs and setup.py docs
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
7 browser/management with build in push/pull server and full text search. It's
9985eca2e4d0 updated docs and setup.py docs
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
8 similar to github or bitbucket, but it's suppose to run as standalone hosted
9985eca2e4d0 updated docs and setup.py docs
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
9 application, it's open source and focuses more on restricted access to
9985eca2e4d0 updated docs and setup.py docs
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
10 repositories. It's powered by vcs_ library that we created to handle many
9985eca2e4d0 updated docs and setup.py docs
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
11 various version control systems.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
12
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
13 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
14
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
15 RhodeCode demo
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
16 --------------
571
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
17
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
18 http://hg.python-works.com
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
19
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
20 The default access is
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
21
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
22 - username: demo
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
23 - password: demo
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
24
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
25 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
26 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
27
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
28 Source code is along with issue tracker is available at
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
29 http://bitbucket.org/marcinkuzminski/rhodecode
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
30
642
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
31 Also a source codes can be obtained from demo RhodeCode instance
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
32 http://hg.python-works.com/rhodecode/summary
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
33
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
34 Features
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
35 --------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
36
642
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
37 - Has it's own middleware to handle mercurial_ and git_ protocol request.
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
38 Each request can be logged and authenticated. Runs on threads unlikely to
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
39 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
40 both on git_ and mercurial_
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
41 - Full permissions and authentication per project private/read/write/admin.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
42 One account for web interface and mercurial_ push/pull/clone.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
43 - Mako templates let's you customize look and feel of application.
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
44 - Beautiful diffs, annotations and source codes all colored by pygments.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
45 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
46 - Admin interface with user/permission management. User activity journal logs
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
47 pulls, pushes, forks,registrations. Possible to disable built in hooks
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
48 - Server side forks, it's possible to fork a project and hack it free without
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
49 breaking the main.
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
50 - Full text search on source codes, search on file names. All powered by whoosh
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
51 and build in indexing daemons
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
52 (no external search servers required all in one application)
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
53 - Rss / atom feeds, gravatar support, download sources as zip/tarballs
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
54 - Async tasks for speed and performance using celery_ (works without them too)
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
55 - Backup scripts can do backup of whole app and send it over scp to desired
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
56 location
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
57 - Setup project descriptions and info inside built in db for easy, non
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
58 file-system operations
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
59 - Added cache with invalidation on push/repo management for high performance and
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
60 always up to date data.
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
61 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
62
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
63
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
64 .. figure:: images/screenshot1_main_page.png
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
65
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
66 Main page of RhodeCode
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
67
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
68 .. figure:: images/screenshot2_summary_page.png
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
69
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
70 Summary page
744
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
71
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
72 .. figure:: images/screenshot3_changelog_page.png
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
73
744
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
74 Changelog with DAG graph
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
75
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
76
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
77 Incoming / Plans
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
78 ----------------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
79
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
80 - code review (probably based on hg-review)
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
81 - full git_ support, with push/pull server
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
82 - project grouping
717
9985eca2e4d0 updated docs and setup.py docs
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
83 - redmine integration
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
84 - commit based build in wiki system
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
85 - clone points and cloning from remote repositories into rhodecode
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
86 (git_ and mercurial_)
642
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
87 - more statistics and graph (global annotation + some more statistics)
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
88 - user customized activity dashboards
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
89 - other cools stuff that i can figure out (or You can help me figure out)
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
90
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
91 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
92 -------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
93
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
94 ``rhodecode`` is released under GPL_ license.
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
95
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
96
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
97 Mailing group Q&A
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
98 -----------------
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
99
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
100 http://groups.google.com/group/rhodecode
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
101
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
102
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
103 Documentation
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
104 -------------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
105
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
106 **Installation:**
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
107
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
108 .. toctree::
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
109 :maxdepth: 1
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
110
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
111 installation
744
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
112 setup
642
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
113 upgrade
585
42a87338035a Version bump.
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
114 changelog
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
115
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
116 Other topics
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
117 ------------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
118
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
119 * :ref:`genindex`
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
120 * :ref:`search`
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
121
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
122 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
123 .. _python: http://www.python.org/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
124 .. _django: http://www.djangoproject.com/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
125 .. _mercurial: http://mercurial.selenic.com/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
126 .. _subversion: http://subversion.tigris.org/
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
127 .. _git: http://git-scm.com/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
128 .. _celery: http://celeryproject.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
129 .. _Sphinx: http://sphinx.pocoo.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
130 .. _GPL: http://www.gnu.org/licenses/gpl.html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
131 .. _vcs: http://pypi.python.org/pypi/vcs