Mercurial > kallithea

annotate README.rst @ 5429:f865477ae919

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
i18n: refreshed translations
author Andrew Shadura <andrew@shadura.me>
date Tue, 25 Aug 2015 12:05:09 +0200
parents 5ae8e644aa88
children fbbe80e3322b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
1 ================
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
2 Kallithea README
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
3 ================
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
4
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
5 About
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
6 -----
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
7
4912
295900ff473d docs: don't use fixed-width fonts when not needed
Andrew Shadura <andrew@shadura.me>
parents: 4902
diff changeset
8 **Kallithea** is a fast and powerful management tool for Mercurial_ and Git_
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
9 with a built-in push/pull server, full text search and code-review. It works on
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
10 http/https and has a built in permission/authentication system with the ability
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
11 to authenticate via LDAP or ActiveDirectory. Kallithea also provides simple API
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
12 so it's easy to integrate with existing external systems.
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
13
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
14 Kallithea is similar in some respects to GitHub_ or Bitbucket_, however
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
15 Kallithea can be run as standalone hosted application on your own server. It is
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
16 open-source donationware and focuses more on providing a customised,
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
17 self-administered interface for Mercurial_ and Git_ repositories. Kallithea
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
18 works on Unix-like systems and Windows, and is powered by the vcs_ library
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
19 created by Łukasz Balcerzak and Marcin Kuźmiński to uniformly handle multiple
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
20 version control systems.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
21
4236
9b5f8a8b2673 Declare this a fork in README.rst
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4235
diff changeset
22 Kallithea was forked from RhodeCode in July 2014 and has been heavily modified.
9b5f8a8b2673 Declare this a fork in README.rst
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4235
diff changeset
23
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
24
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
25 Installation
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
26 ------------
5401
11bc459d010b docs: clarify Python 2 requirement in README
Mads Kiilerich <madski@unity3d.com>
parents: 4979
diff changeset
27 Kallithea requires Python_ 2.x and it is recommended to install it in a
11bc459d010b docs: clarify Python 2 requirement in README
Mads Kiilerich <madski@unity3d.com>
parents: 4979
diff changeset
28 virtualenv_. Official releases of Kallithea can be installed with::
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
29
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4184
diff changeset
30 pip install kallithea
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
31
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
32 The development repository is kept very stable and used in production by the
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
33 developers -- you can do the same.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
34
4921
24e426cd40ac README: link to readthedocs.org rather than python.org for documentation
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4913
diff changeset
35 Please visit https://docs.kallithea-scm.org/en/latest/installation.html for
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
36 more details.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
37
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
38
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
39 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
40 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
41
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
42 The latest sources can be obtained from
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
43 https://kallithea-scm.org/repos/kallithea.
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
44
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
45 The issue tracker and a repository mirror can be found at Bitbucket_ on
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
46 https://bitbucket.org/conservancy/kallithea.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
47
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
48
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5401
diff changeset
49 Kallithea features
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
50 ------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
51
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
52 - Has its own middleware to handle Mercurial_ and Git_ protocol requests. Each
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
53 request is authenticated and logged together with IP address.
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
54 - Built for speed and performance. You can make multiple pulls/pushes
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
55 simultaneously. Proven to work with thousands of repositories and users.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
56 - Supports http/https, LDAP, AD, proxy-pass authentication.
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
57 - Full permissions (private/read/write/admin) together with IP restrictions for
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
58 each repository, additional explicit forking, repositories group and
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
59 repository creation permissions.
3848
832907f41ee6 updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 3410
diff changeset
60 - User groups for easier permission management.
832907f41ee6 updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 3410
diff changeset
61 - Repository groups let you group repos and manage them easier. They come with
832907f41ee6 updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 3410
diff changeset
62 permission delegation features, so you can delegate groups management.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
63 - Users can fork other users repos, and compare them at any time.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
64 - Built-in versioned paste functionality (Gist) for sharing code snippets.
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
65 - Integrates easily with other systems, with custom created mappers you can
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
66 connect it to almost any issue tracker, and with a JSON-RPC API you can make
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
67 much more.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
68 - Built-in commit API lets you add, edit and commit files right from Kallithea
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
69 web interface using simple editor or upload binary files using simple form.
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
70 - Powerful pull request driven review system with inline commenting, changeset
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
71 statuses, and notification system.
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
72 - Importing and syncing repositories from remote locations for Git_, Mercurial_
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
73 and Subversion.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
74 - Mako templates let you customize the look and feel of the application.
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
75 - Beautiful diffs, annotations and source code browsing all colored by
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
76 pygments. Raw diffs are made in Git-diff format for both VCS systems,
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
77 including Git_ binary-patches.
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
78 - Mercurial_ and Git_ DAG graphs and Flot-powered graphs with zooming and
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
79 statistics to track activity for repositories.
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
80 - Admin interface with user/permission management. Admin activity journal, logs
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
81 pulls, pushes, forks, registrations and other actions made by all users.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
82 - Server side forks. It is possible to fork a project and modify it freely
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
83 without breaking the main repository.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
84 - reST and Markdown README support for repositories.
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
85 - Full text search powered by Whoosh on the source files, commit messages, and
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
86 file names. Built-in indexing daemons, with optional incremental index build
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
87 (no external search servers required all in one application).
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
88 - Setup project descriptions/tags and info inside built in DB for easy,
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
89 non-filesystem operations.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
90 - Intelligent cache with invalidation after push or project change, provides
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
91 high performance and always up to date data.
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
92 - RSS/Atom feeds, Gravatar support, downloadable sources as zip/tar/gz.
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
93 - Optional async tasks for speed and performance using Celery_.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
94 - Backup scripts can do backup of whole app and send it over scp to desired
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
95 location.
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
96 - Based on Pylons, SQLAlchemy, SQLite, Whoosh, vcs.
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
97
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
98
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
99 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
100 -------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
101
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
102 **Kallithea** is released under the GPLv3 license. Kallithea is a `Software
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
103 Freedom Conservancy`_ project and thus controlled by a non-profit organization.
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
104 No commercial entity can take ownership of the project and change the
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
105 direction.
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
106
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
107 Kallithea started out as an effort to make sure the existing GPLv3 codebase
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
108 would stay available under a legal license. Kallithea thus has to stay GPLv3
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
109 compatible ... but we are also happy it is GPLv3 and happy to keep it that way.
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
110 A different license (such as AGPL) could perhaps help attract a different
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
111 community with a different mix of Free Software people and companies but we are
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
112 happy with the current focus.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
113
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
114
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
115 Community
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
116 ---------
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
117
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
118 **Kallithea** is maintained by its users who contribute the fixes they would
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
119 like to see.
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
120
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
121 Get in touch with the rest of the community:
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
122
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
123 - Join the mailing list users and developers -- see
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
124 http://lists.sfconservancy.org/mailman/listinfo/kallithea-general.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
125
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
126 - Use IRC and join #kallithea on FreeNode (irc.freenode.net) or use
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
127 http://webchat.freenode.net/?channels=kallithea.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
128
4912
295900ff473d docs: don't use fixed-width fonts when not needed
Andrew Shadura <andrew@shadura.me>
parents: 4902
diff changeset
129 - Follow Kallithea on Twitter, **@KallitheaSCM**.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
130
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
131 - Issues can be reported at `issue tracker
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
132 <https://bitbucket.org/conservancy/kallithea/issues>`_.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
133
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
134 .. note::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
135
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
136 Please try to read the documentation before posting any issues,
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
137 especially the **troubleshooting section**
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
138
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
139
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
140 Online documentation
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
141 --------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
142
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
143 Online documentation for the current version of Kallithea is available at
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
144 https://pythonhosted.org/Kallithea/. Documentation for the current development
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
145 version can be found on https://docs.kallithea-scm.org/.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
146
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
147 You can also build the documentation locally: go to ``docs/`` and run::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
148
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
149 make html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
150
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4947
diff changeset
151 .. note:: You need to have Sphinx_ installed to build the
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4947
diff changeset
152 documentation. If you don't have Sphinx_ installed you can
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4947
diff changeset
153 install it via the command: ``pip install sphinx`` .
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
154
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
155
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
156 Converting from RhodeCode
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
157 -------------------------
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
158
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
159 Currently, you have two options for working with an existing RhodeCode
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
160 database:
4979
12fb00adc05f readme: fix invalid rst
Mads Kiilerich <madski@unity3d.com>
parents: 4955
diff changeset
161
12fb00adc05f readme: fix invalid rst
Mads Kiilerich <madski@unity3d.com>
parents: 4955
diff changeset
162 - keep the database unconverted (intended for testing and evaluation)
12fb00adc05f readme: fix invalid rst
Mads Kiilerich <madski@unity3d.com>
parents: 4955
diff changeset
163 - convert the database in a one-time step
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
164
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5401
diff changeset
165 Maintaining interoperability
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
166 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
167
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
168 Interoperability with RhodeCode 2.2.X installations is provided so you don't
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
169 have to immediately commit to switching to Kallithea. This option will most
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
170 likely go away once the two projects have diverged significantly.
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
171
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
172 To run Kallithea on a RhodeCode database, run::
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
173
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
174 echo "BRAND = 'rhodecode'" > kallithea/brand.py
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
175
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
176 This location will depend on where you installed Kallithea. If you installed
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
177 via::
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
178
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
179 python setup.py install
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
180
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
181 then you will find this location at
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
182 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``.
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
183
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5401
diff changeset
184 One-time conversion
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
185 ~~~~~~~~~~~~~~~~~~~
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
186
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
187 Alternatively, if you would like to convert the database for good, you can use
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
188 a helper script provided by Kallithea. This script will operate directly on the
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
189 database, using the database string you can find in your ``production.ini`` (or
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
190 ``development.ini``) file. For example, if using SQLite::
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
191
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
192 cd /path/to/kallithea
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
193 cp /path/to/rhodecode/rhodecode.db kallithea.db
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
194 pip install sqlalchemy-migrate
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
195 python kallithea/bin/rebranddb.py sqlite:///kallithea.db
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
196
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
197 .. Note::
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
198
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
199 If you started out using the branding interoperability approach mentioned
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
200 above, watch out for stray brand.pyc after removing brand.py.
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
201
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
202
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
203 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
204 .. _Python: http://www.python.org/
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
205 .. _Sphinx: http://sphinx.pocoo.org/
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
206 .. _Mercurial: http://mercurial.selenic.com/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
207 .. _Bitbucket: http://bitbucket.org/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
208 .. _GitHub: http://github.com/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
209 .. _Subversion: http://subversion.tigris.org/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
210 .. _Git: http://git-scm.com/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
211 .. _Celery: http://celeryproject.org/
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
212 .. _vcs: http://pypi.python.org/pypi/vcs
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
213 .. _Software Freedom Conservancy: http://sfconservancy.org/