Mercurial > kallithea
annotate README.rst @ 5029:d20ea885f6cb
db: simplify PullRequestReviewers model
author | Ronny Pfannschmidt <opensource@ronnypfannschmidt.de> |
---|---|
date | Fri, 17 Apr 2015 22:23:51 +0200 |
parents | 12fb00adc05f |
children | 11bc459d010b |
rev | line source |
---|---|
4902 | 1 ================ |
2 Kallithea README | |
3 ================ | |
2020 | 4 |
5 About | |
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 | 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 |
2020 | 24 Installation |
25 ------------ | |
4902 | 26 Official releases of Kallithea can be installed via:: |
2020 | 27 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4184
diff
changeset
|
28 pip install kallithea |
2020 | 29 |
4902 | 30 The development repository is kept very stable and used in production by the |
31 developers - you can do the same. | |
2020 | 32 |
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
|
33 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
|
34 more details. |
2020 | 35 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
36 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
37 Source code |
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 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
40 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
|
41 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
|
42 |
4902 | 43 The issue tracker and a repository mirror can be found at Bitbucket_ on |
44 https://bitbucket.org/conservancy/kallithea. | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
45 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
46 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
47 |
4212
24c0d584ba86
General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
48 Kallithea Features |
1093 | 49 ------------------ |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
50 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
51 - 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
|
52 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
|
53 - 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
|
54 simultaneously. Proven to work with thousands of repositories and users. |
3184 | 55 - 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
|
56 - 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
|
57 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
|
58 repository creation permissions. |
3848 | 59 - User groups for easier permission management. |
60 - Repository groups let you group repos and manage them easier. They come with | |
61 permission delegation features, so you can delegate groups management. | |
3184 | 62 - 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
|
63 - 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
|
64 - 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
|
65 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
|
66 much more. |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
67 - Built-in commit API lets you add, edit and commit files right from Kallithea |
3184 | 68 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
|
69 - 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
|
70 statuses, and notification system. |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
71 - 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
|
72 and Subversion. |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
73 - 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
|
74 - 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
|
75 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
|
76 including Git_ binary-patches. |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
77 - 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
|
78 statistics to track activity for repositories. |
847 | 79 - Admin interface with user/permission management. Admin activity journal, logs |
80 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
|
81 - Server side forks. It is possible to fork a project and modify it freely |
3184 | 82 without breaking the main repository. |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
83 - 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
|
84 - 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
|
85 file names. Built-in indexing daemons, with optional incremental index build |
4902 | 86 (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
|
87 - 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
|
88 non-filesystem operations. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
89 - 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
|
90 high performance and always up to date data. |
4902 | 91 - RSS/Atom feeds, Gravatar support, downloadable sources as zip/tar/gz. |
92 - Optional async tasks for speed and performance using Celery_. | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
93 - Backup scripts can do backup of whole app and send it over scp to desired |
4902 | 94 location. |
95 - 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
|
96 |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
97 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
98 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
99 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
100 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
101 **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
|
102 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
|
103 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
|
104 direction. |
4902 | 105 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
106 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
|
107 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
|
108 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
|
109 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
|
110 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
|
111 happy with the current focus. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
112 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
113 |
4902 | 114 Community |
115 --------- | |
116 | |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
117 **Kallithea** is maintained by its users who contribute the fixes they would |
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
118 like to see. |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
119 |
4902 | 120 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
|
121 |
4902 | 122 - Join the mailing list users and developers - see |
123 http://lists.sfconservancy.org/mailman/listinfo/kallithea-general. | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
124 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
125 - 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
|
126 http://webchat.freenode.net/?channels=kallithea. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
127 |
4912
295900ff473d
docs: don't use fixed-width fonts when not needed
Andrew Shadura <andrew@shadura.me>
parents:
4902
diff
changeset
|
128 - Follow Kallithea on Twitter, **@KallitheaSCM**. |
2020 | 129 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
130 - 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
|
131 <https://bitbucket.org/conservancy/kallithea/issues>`_. |
2020 | 132 |
4902 | 133 .. note:: |
134 | |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
135 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
|
136 especially the **troubleshooting section** |
2020 | 137 |
796 | 138 |
139 Online documentation | |
140 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
141 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
142 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
|
143 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
|
144 version can be found on https://docs.kallithea-scm.org/. |
2020 | 145 |
4902 | 146 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
|
147 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
148 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
149 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4947
diff
changeset
|
150 .. 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
|
151 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
|
152 install it via the command: ``pip install sphinx`` . |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
153 |
4227
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 Converting from RhodeCode |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
156 ------------------------- |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
157 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
158 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
|
159 database: |
4979
12fb00adc05f
readme: fix invalid rst
Mads Kiilerich <madski@unity3d.com>
parents:
4955
diff
changeset
|
160 |
12fb00adc05f
readme: fix invalid rst
Mads Kiilerich <madski@unity3d.com>
parents:
4955
diff
changeset
|
161 - keep the database unconverted (intended for testing and evaluation) |
12fb00adc05f
readme: fix invalid rst
Mads Kiilerich <madski@unity3d.com>
parents:
4955
diff
changeset
|
162 - 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
|
163 |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
164 Maintaining Interoperability |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
166 |
4902 | 167 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
|
168 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
|
169 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
|
170 |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
171 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
|
172 |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
173 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
|
174 |
4947
437ecfbba58d
README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents:
4921
diff
changeset
|
175 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
|
176 via:: |
4227
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 python setup.py install |
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 then you will find this location at |
4902 | 181 ``$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
|
182 |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
183 One-time Conversion |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
184 ~~~~~~~~~~~~~~~~~~~ |
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 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
|
187 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
|
188 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
|
189 ``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
|
190 |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
191 cd /path/to/kallithea |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
192 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
|
193 pip install sqlalchemy-migrate |
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
194 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
|
195 |
4902 | 196 .. Note:: |
4227
6de8a139ab07
readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents:
4212
diff
changeset
|
197 |
4902 | 198 If you started out using the branding interoperability approach mentioned |
199 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
|
200 |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
201 .. _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
|
202 .. _Python: http://www.python.org/ |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
203 .. _Sphinx: http://sphinx.pocoo.org/ |
4258
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
204 .. _Mercurial: http://mercurial.selenic.com/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
205 .. _Bitbucket: http://bitbucket.org/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
206 .. _GitHub: http://github.com/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
207 .. _Subversion: http://subversion.tigris.org/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
208 .. _Git: http://git-scm.com/ |
df5d8a67c30c
Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents:
4236
diff
changeset
|
209 .. _Celery: http://celeryproject.org/ |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3184
diff
changeset
|
210 .. _vcs: http://pypi.python.org/pypi/vcs |
4902 | 211 .. _Software Freedom Conservancy: http://sfconservancy.org/ |