Mercurial > kallithea

annotate README.rst @ 4845:3a3ec35466e7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
templates: move site branding in page title to base template Instead of repeating the same three lines in each and every template, move it to the base template.
author Thomas De Schampheleire <thomas.de_schampheleire@alcatel-lucent.com>
date Mon, 23 Feb 2015 22:11:38 +0100
parents df5d8a67c30c
children 03bbd33bc084
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
1 =========
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4192
diff changeset
2 Kallithea
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
3 =========
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
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
8 ``Kallithea`` is a fast and powerful management tool for Mercurial_ and Git_
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
9 with a built-in push/pull server, full text search and code-review.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
10 It works on http/https and has a built in permission/authentication system with
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4192
diff changeset
11 the ability to authenticate via LDAP or ActiveDirectory. Kallithea also provides
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
12 simple API 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
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
14 Kallithea is similar in some respects to GitHub_ or Bitbucket_,
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4192
diff changeset
15 however Kallithea can be run as standalone hosted application on your own server.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
16 It is open-source donationware and focuses more on providing a customised,
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
17 self-administered interface for Mercurial_ and Git_ repositories.
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
18 Kallithea works on Unix-like systems and Windows, and is powered by the vcs_ library
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
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
24 Installation
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
25 ------------
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4192
diff changeset
26 Stable releases of Kallithea are best installed via::
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
27
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4184
diff changeset
28 easy_install kallithea
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
29
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
30 Or::
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
31
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4184
diff changeset
32 pip install kallithea
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
33
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
34 Detailed instructions and links may be found on the Installation page.
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
35
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4184
diff changeset
36 Please visit http://packages.python.org/Kallithea/installation.html for
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
37 more details.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
38
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
39
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
40 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
41 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
42
4179
010e9532801a Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3960
diff changeset
43 The latest sources can be obtained from https://kallithea-scm.org/repos/kallithea
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
44
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
45
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
46 MIRRORS:
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
47
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
48 Issue tracker and sources at Bitbucket_
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
49
4179
010e9532801a Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3960
diff changeset
50 https://bitbucket.org/conservancy/kallithea
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
51
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
52
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
53
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4192
diff changeset
54 Kallithea Features
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
55 ------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
56
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
57 - Has its own middleware to handle Mercurial_ and Git_ protocol requests.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
58 Each request is authenticated and logged together with IP address.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
59 - Built for speed and performance. You can make multiple pulls/pushes simultaneously.
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
60 Proven to work with thousands of repositories and users.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
61 - Supports http/https, LDAP, AD, proxy-pass authentication.
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
62 - Full permissions (private/read/write/admin) together with IP restrictions for each repository,
3848
832907f41ee6 updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 3410
diff changeset
63 additional explicit forking, repositories group and repository creation permissions.
832907f41ee6 updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 3410
diff changeset
64 - User groups for easier permission management.
832907f41ee6 updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 3410
diff changeset
65 - 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
66 permission delegation features, so you can delegate groups management.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
67 - 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
68 - Built-in versioned paste functionality (Gist) for sharing code snippets.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
69 - Integrates easily with other systems, with custom created mappers you can connect it to almost
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
70 any issue tracker, and with an JSON-RPC API you can make much more
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
71 - 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
72 web interface using simple editor or upload binary files using simple form.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
73 - Powerful pull request driven review system with inline commenting,
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
74 changeset statuses, and notification system.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
75 - Importing and syncing repositories from remote locations for Git_, Mercurial_ and Subversion.
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
76 - Mako templates let you customize the look and feel of the application.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
77 - Beautiful diffs, annotations and source code browsing all colored by pygments.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
78 Raw diffs are made in Git-diff format for both VCS systems, including Git_ binary-patches
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
79 - Mercurial_ and Git_ DAG graphs and Flot-powered graphs with zooming and statistics
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
80 to track activity for repositories
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
81 - Admin interface with user/permission management. Admin activity journal, logs
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
82 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
83 - 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
84 without breaking the main repository.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
85 - reST and Markdown README support for repositories.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
86 - Full text search powered by Whoosh on the source files, commit messages, and file names.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
87 Built-in indexing daemons, with optional incremental index build
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
88 (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
89 - 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
90 non-filesystem operations.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
91 - 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
92 high performance and always up to date data.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
93 - RSS/Atom feeds, Gravatar support, downloadable sources as zip/tar/gz
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
94 - Optional async tasks for speed and performance using Celery_
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
95 - Backup scripts can do backup of whole app and send it over scp to desired
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
96 location
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
97 - Based on Pylons, SQLAlchemy, SQLite, Whoosh, vcs
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
98
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
99
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
100 Incoming / Plans
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
101 ----------------
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
102
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
103 - Finer granular permissions per branch, or subrepo
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
104 - Web-based merges for pull requests
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
105 - Tracking history for each lines in files
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
106 - Simple issue tracker
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
107 - SSH-based authentication with server side key management
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
108 - Commit based built in wiki system
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
109 - More statistics and graph (global annotation + some more statistics)
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
110 - Other advancements as development continues (or you can of course make
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
111 additions and or requests)
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
112
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
113 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
114 -------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
115
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4192
diff changeset
116 ``Kallithea`` is released under the GPLv3 license.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
117
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
118
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
119 Getting help
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
120 ------------
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
121
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
122 Listed bellow are various support resources that should help.
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
123
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
124 .. note::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
125
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 2266
diff changeset
126 Please try to read the documentation before posting any issues, especially
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 2266
diff changeset
127 the **troubleshooting section**
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
128
4179
010e9532801a Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3960
diff changeset
129 - Open an issue at `issue tracker <https://bitbucket.org/conservancy/kallithea/issues>`_
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
130
4180
08af8038e1cc Change IRC channel and Twitter account; remove google group
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4179
diff changeset
131 - Join #kallithea on FreeNode (irc.freenode.net)
08af8038e1cc Change IRC channel and Twitter account; remove google group
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4179
diff changeset
132 or use http://webchat.freenode.net/?channels=kallithea for web access to irc.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
133
4180
08af8038e1cc Change IRC channel and Twitter account; remove google group
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4179
diff changeset
134 You can follow this project on Twitter, **@KallitheaSCM**.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
135
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
136
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
137 Online documentation
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
138 --------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
139
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4192
diff changeset
140 Online documentation for the current version of Kallithea is available at
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4184
diff changeset
141 - http://packages.python.org/Kallithea/
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4184
diff changeset
142 - http://kallithea.readthedocs.org/
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
143
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
144 You may also build the documentation for yourself: go into ``docs/`` and run::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
145
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
146 make html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
147
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
148 (You need to have Sphinx_ installed to build the documentation. If you don't
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
149 have Sphinx_ installed you can install it via the command:
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
150 ``easy_install sphinx``)
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
151
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
152
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
153 Converting from RhodeCode
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
154 -------------------------
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 Currently, you have two options for working with an existing RhodeCode database:
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
157 - keep the database unconverted (intended for testing and evaluation)
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
158 - convert the database in a one-time step
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
159
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
160 Maintaining Interoperability
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
162
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
163 Interoperability with RhodeCode 2.2.5 installations is provided so you don't
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
164 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
165 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
166
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
167 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
168
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
169 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
170
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
171 This location will depend on where you installed Kallithea. If you installed via::
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
172
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
173 python setup.py install
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
174
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
175 then you will find this location at
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
176 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-2.2.5-py2.7.egg/kallithea``
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
177
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
178 One-time Conversion
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
179 ~~~~~~~~~~~~~~~~~~~
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 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
182 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
183 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
184 ``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
185
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
186 cd /path/to/kallithea
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
187 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
188 pip install sqlalchemy-migrate
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
189 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
190
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
191 .. WARNING::
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
192
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
193 If you used the other method for interoperability, overwrite brand.py with
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
194 an empty file (or watch out for stray brand.pyc after removing brand.py).
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
195
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
196 .. _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
197 .. _Python: http://www.python.org/
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
198 .. _Sphinx: http://sphinx.pocoo.org/
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
199 .. _Mercurial: http://mercurial.selenic.com/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
200 .. _Bitbucket: http://bitbucket.org/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
201 .. _GitHub: http://github.com/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
202 .. _Subversion: http://subversion.tigris.org/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
203 .. _Git: http://git-scm.com/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
204 .. _Celery: http://celeryproject.org/
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
205 .. _vcs: http://pypi.python.org/pypi/vcs