Mercurial > kallithea

annotate docs/index.rst @ 771:16884b3e42cb beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added irc channel to docs
author Marcin Kuzminski <marcin@python-works.com>
date Fri, 26 Nov 2010 11:39:12 +0100
parents 6e8322c438ca
children 47d5781bfe8a
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
762
6e8322c438ca docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
3 =================================================
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
4 Welcome to RhodeCode (RhodiumCode) documentation!
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
5 =================================================
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
6
762
6e8322c438ca docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
7 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository
6e8322c438ca docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
8 browser/management with build in push/pull server and full text search.
6e8322c438ca docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
9 It works on http/https, has build in permission/authentication(+ldap) features
6e8322c438ca docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
10 It's similar to github or bitbucket, but it's suppose to run as standalone hosted
717
9985eca2e4d0 updated docs and setup.py docs
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
11 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
12 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
13 various version control systems.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
14
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
15 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
16
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
17 RhodeCode demo
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
18 --------------
571
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 http://hg.python-works.com
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 The default access is
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
23
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
24 - username: demo
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
25 - password: demo
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
26
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
27 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
28 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
29
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
30 Source code is along with issue tracker is available at
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
31 http://bitbucket.org/marcinkuzminski/rhodecode
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
32
642
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
33 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
34 http://hg.python-works.com/rhodecode/summary
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
35
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
36 Features
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
37 --------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
38
642
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
39 - 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
40 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
41 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
42 both on git_ and mercurial_
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
43 - 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
44 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
45 - 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
46 - 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
47 - 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
48 - 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
49 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
50 - 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
51 breaking the main.
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
52 - 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
53 and build in indexing daemons
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
54 (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
55 - 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
56 - 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
57 - 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
58 location
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
59 - 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
60 file-system operations
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
61 - 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
62 always up to date data.
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
63 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
64
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
65
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
66 .. figure:: images/screenshot1_main_page.png
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 Main page of RhodeCode
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 .. figure:: images/screenshot2_summary_page.png
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
71
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
72 Summary page
744
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
73
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
74 .. figure:: images/screenshot3_changelog_page.png
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
75
744
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
76 Changelog with DAG graph
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
77
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
78
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
79 Incoming / Plans
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
80 ----------------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
81
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
82 - code review (probably based on hg-review)
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
83 - 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
84 - project grouping
717
9985eca2e4d0 updated docs and setup.py docs
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
85 - redmine integration
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
86 - commit based build in wiki system
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
87 - clone points and cloning from remote repositories into rhodecode
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
88 (git_ and mercurial_)
642
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
89 - more statistics and graph (global annotation + some more statistics)
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
90 - user customized activity dashboards
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
91 - other cools stuff that i can figure out (or You can help me figure out)
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
92
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
93 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
94 -------
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 ``rhodecode`` is released under GPL_ license.
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
97
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
98
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
99 Mailing group Q&A
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
100 -----------------
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
101
762
6e8322c438ca docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
102 join the `Google group <http://groups.google.com/group/rhodecode>`_
6e8322c438ca docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
103
6e8322c438ca docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 744
diff changeset
104 open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
105
771
16884b3e42cb added irc channel to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 762
diff changeset
106 join #rhodecode on FreeNode (irc.freenode.net)
16884b3e42cb added irc channel to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 762
diff changeset
107 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
108
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
109 Documentation
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
110 -------------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
111
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
112 **Installation:**
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
113
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
114 .. toctree::
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
115 :maxdepth: 1
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
116
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
117 installation
744
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
118 setup
642
674ecf21de85 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
119 upgrade
585
42a87338035a Version bump.
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
120 changelog
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
121
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
122 Other topics
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
123 ------------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
124
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
125 * :ref:`genindex`
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
126 * :ref:`search`
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
127
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
128 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
129 .. _python: http://www.python.org/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
130 .. _django: http://www.djangoproject.com/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
131 .. _mercurial: http://mercurial.selenic.com/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
132 .. _subversion: http://subversion.tigris.org/
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
133 .. _git: http://git-scm.com/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
134 .. _celery: http://celeryproject.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
135 .. _Sphinx: http://sphinx.pocoo.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
136 .. _GPL: http://www.gnu.org/licenses/gpl.html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
137 .. _vcs: http://pypi.python.org/pypi/vcs