Mercurial > kallithea

annotate README.rst @ 7867:4e54b61f52e9 default-i18n

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
i18n: regenerate translation data (commit de1342abcf42) Regenerate translation data based on new development on the default branch, including removal of the repository locking feature, and addition of SSH repository access. This commit was created via: scripts/i18n-update export <repo> -r de1342abcf42
author Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
date Mon, 02 Sep 2019 21:43:37 +0200
parents e4f27ab7cbea
children 89e9aef9b983
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
5433
fbbe80e3322b docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents: 5425
diff changeset
5
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
6 About
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
7 -----
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
8
4912
295900ff473d docs: don't use fixed-width fonts when not needed
Andrew Shadura <andrew@shadura.me>
parents: 4902
diff changeset
9 **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
10 with a built-in push/pull server, full text search and code-review. It works on
7783
e4f27ab7cbea ssh: add documentation of SSH support
Christian Oyarzun <oyarzun@gmail.com>
parents: 7746
diff changeset
11 HTTP/HTTPS and SSH, has a built-in permission/authentication system with the ability
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
12 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
13 so it's easy to integrate with existing external systems.
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
14
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
15 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
16 Kallithea can be run as standalone hosted application on your own server. It is
7746
5bca0d56a67a readme: some minor updates for TurboGears2 and various other tweaks
Mads Kiilerich <mads@kiilerich.com>
parents: 7348
diff changeset
17 open-source and focuses more on providing a customised,
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
18 self-administered interface for Mercurial_ and Git_ repositories. Kallithea
7746
5bca0d56a67a readme: some minor updates for TurboGears2 and various other tweaks
Mads Kiilerich <mads@kiilerich.com>
parents: 7348
diff changeset
19 works on Unix-like systems and Windows.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
20
4236
9b5f8a8b2673 Declare this a fork in README.rst
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4235
diff changeset
21 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
22
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
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 ------------
5433
fbbe80e3322b docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents: 5425
diff changeset
26
7746
5bca0d56a67a readme: some minor updates for TurboGears2 and various other tweaks
Mads Kiilerich <mads@kiilerich.com>
parents: 7348
diff changeset
27 Kallithea requires Python_ 2.7 and it is recommended to install it in a
5401
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
5494
57caeb60c52b docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents: 5452
diff changeset
38 There is also an experimental `Puppet module`_ for installing and setting up
57caeb60c52b docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents: 5452
diff changeset
39 Kallithea. Currently, only basic functionality is provided, but it is still
57caeb60c52b docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents: 5452
diff changeset
40 enough to get up and running quickly, especially for people without Python
57caeb60c52b docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents: 5452
diff changeset
41 background. See
57caeb60c52b docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents: 5452
diff changeset
42 https://docs.kallithea-scm.org/en/latest/installation_puppet.html for further
57caeb60c52b docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents: 5452
diff changeset
43 information.
57caeb60c52b docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents: 5452
diff changeset
44
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
45
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
46 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
47 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
48
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
49 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
50 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
51
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
52 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
53 https://bitbucket.org/conservancy/kallithea.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
54
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
55
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5401
diff changeset
56 Kallithea features
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
57 ------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
58
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
59 - 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
60 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
61 - 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
62 simultaneously. Proven to work with thousands of repositories and users.
7746
5bca0d56a67a readme: some minor updates for TurboGears2 and various other tweaks
Mads Kiilerich <mads@kiilerich.com>
parents: 7348
diff changeset
63 - Supports HTTP/HTTPS with LDAP, AD, or proxy-pass authentication.
7783
e4f27ab7cbea ssh: add documentation of SSH support
Christian Oyarzun <oyarzun@gmail.com>
parents: 7746
diff changeset
64 - Supports SSH access with server-side public key management.
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
65 - 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
66 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
67 repository creation permissions.
3848
832907f41ee6 updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 3410
diff changeset
68 - User groups for easier permission management.
832907f41ee6 updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 3410
diff changeset
69 - 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
70 permission delegation features, so you can delegate groups management.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
71 - 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
72 - 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
73 - 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
74 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
75 much more.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
76 - 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
77 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
78 - 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
79 statuses, and notification system.
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
80 - 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
81 and Subversion.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
82 - 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
83 - 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
84 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
85 including Git_ binary-patches.
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
86 - 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
87 statistics to track activity for repositories.
7746
5bca0d56a67a readme: some minor updates for TurboGears2 and various other tweaks
Mads Kiilerich <mads@kiilerich.com>
parents: 7348
diff changeset
88 - Admin interface with user/permission management. Admin activity journal logs
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
89 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
90 - 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
91 without breaking the main repository.
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
92 - 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
93 - 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
94 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
95 (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
96 - 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
97 non-filesystem operations.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
98 - 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
99 high performance and always up to date data.
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
100 - RSS/Atom feeds, Gravatar support, downloadable sources as zip/tar/gz.
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
101 - Optional async tasks for speed and performance using Celery_.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
102 - 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
103 location.
7746
5bca0d56a67a readme: some minor updates for TurboGears2 and various other tweaks
Mads Kiilerich <mads@kiilerich.com>
parents: 7348
diff changeset
104 - Based on TurboGears2, SQLAlchemy, Whoosh, Bootstrap, and other open source
5bca0d56a67a readme: some minor updates for TurboGears2 and various other tweaks
Mads Kiilerich <mads@kiilerich.com>
parents: 7348
diff changeset
105 libraries.
5bca0d56a67a readme: some minor updates for TurboGears2 and various other tweaks
Mads Kiilerich <mads@kiilerich.com>
parents: 7348
diff changeset
106 - Uses PostgreSQL, SQLite, or MariaDB/MySQL databases.
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
107
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
108
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
109 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
110 -------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
111
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
112 **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
113 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
114 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
115 direction.
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
116
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
117 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
118 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
119 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
120 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
121 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
122 happy with the current focus.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
123
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
124
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
125 Community
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
126 ---------
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
127
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
128 **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
129 like to see.
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
130
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
131 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
132
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
133 - Join the mailing list users and developers -- see
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
134 http://lists.sfconservancy.org/mailman/listinfo/kallithea-general.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
135
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
136 - 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
137 http://webchat.freenode.net/?channels=kallithea.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
138
4912
295900ff473d docs: don't use fixed-width fonts when not needed
Andrew Shadura <andrew@shadura.me>
parents: 4902
diff changeset
139 - Follow Kallithea on Twitter, **@KallitheaSCM**.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
140
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
141 - 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
142 <https://bitbucket.org/conservancy/kallithea/issues>`_.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
143
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
144 .. note::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
145
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
146 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
147 especially the **troubleshooting section**
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
148
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
149
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
150 Online documentation
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
151 --------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
152
4947
437ecfbba58d README: set fill column to 80
Sean Farley <sean.michael.farley@gmail.com>
parents: 4921
diff changeset
153 Online documentation for the current version of Kallithea is available at
7333
99cd328da2a1 remove references to pythonhosted.org (issue #293)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 5502
diff changeset
154 https://docs.kallithea-scm.org/en/stable/. Documentation for the current development
99cd328da2a1 remove references to pythonhosted.org (issue #293)
Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
parents: 5502
diff changeset
155 version can be found on https://docs.kallithea-scm.org/en/default/.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
156
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
157 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
158
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
159 make html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
160
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4947
diff changeset
161 .. 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
162 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
163 install it via the command: ``pip install sphinx`` .
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
164
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
165
6013
0b6d2ca7175f db: drop RhodeCode compatibility (database rebranding etc.)
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
166 Migrating from RhodeCode
0b6d2ca7175f db: drop RhodeCode compatibility (database rebranding etc.)
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
167 ------------------------
4227
6de8a139ab07 readme: instructions for working with RhodeCode database
Sean Farley <sean.michael.farley@gmail.com>
parents: 4212
diff changeset
168
6013
0b6d2ca7175f db: drop RhodeCode compatibility (database rebranding etc.)
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
169 Kallithea 0.3.2 and earlier supports migrating from an existing RhodeCode
0b6d2ca7175f db: drop RhodeCode compatibility (database rebranding etc.)
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
170 installation. To migrate, install Kallithea 0.3.2 and follow the
0b6d2ca7175f db: drop RhodeCode compatibility (database rebranding etc.)
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
171 instructions in the 0.3.2 README to perform a one-time conversion of the
0b6d2ca7175f db: drop RhodeCode compatibility (database rebranding etc.)
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
172 database from RhodeCode to Kallithea, before upgrading to this version
0b6d2ca7175f db: drop RhodeCode compatibility (database rebranding etc.)
Søren Løvborg <sorenl@unity3d.com>
parents: 5575
diff changeset
173 of Kallithea.
5452
c3d83238afa1 git: add option for forcing overwrite of Git hooks when remapping and rescanning the repositories. (Issue #153)
Branko Majic <branko@majic.rs>
parents: 5433
diff changeset
174
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5413
diff changeset
175
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
176 .. _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
177 .. _Python: http://www.python.org/
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
178 .. _Sphinx: http://sphinx.pocoo.org/
4258
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
179 .. _Mercurial: http://mercurial.selenic.com/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
180 .. _Bitbucket: http://bitbucket.org/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
181 .. _GitHub: http://github.com/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
182 .. _Subversion: http://subversion.tigris.org/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
183 .. _Git: http://git-scm.com/
df5d8a67c30c Add some beauty to the README.rst
Andrew Shadura <andrew@shadura.me>
parents: 4236
diff changeset
184 .. _Celery: http://celeryproject.org/
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4258
diff changeset
185 .. _Software Freedom Conservancy: http://sfconservancy.org/
5494
57caeb60c52b docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents: 5452
diff changeset
186 .. _Puppet module: https://forge.puppetlabs.com/rauch/kallithea