kallithea Changeset - 5ae8e644aa88

Changeset - 5ae8e644aa88

Parent rev.

Child rev.

[Not reviewed]

default

0 14 0

Søren Løvborg - 11 years ago 2015-08-18 11:47:19
sorenl@unity3d.com

docs: spelling, grammar, content and typography

14 files changed with 219 insertions and 177 deletions:

README.rst

docs/api/api.rst

docs/changelog.rst

docs/conf.py

docs/contributing.rst

docs/installation.rst

docs/installation_iis.rst

docs/installation_win_old.rst

docs/setup.rst

docs/usage/general.rst

docs/usage/locking.rst

docs/usage/performance.rst

docs/usage/statistics.rst

docs/usage/troubleshooting.rst

0 comments (0 inline, 0 general)

README.rst

➞

Show inline comments

 ================
 Kallithea README
 ================
 About
 -----
 **Kallithea** is a fast and powerful management tool for Mercurial_ and Git_
 with a built-in push/pull server, full text search and code-review. It works on
 http/https and has a built in permission/authentication system with the ability
 to authenticate via LDAP or ActiveDirectory. Kallithea also provides simple API
 so it's easy to integrate with existing external systems.
 Kallithea is similar in some respects to GitHub_ or Bitbucket_, however
 Kallithea can be run as standalone hosted application on your own server. It is
 open-source donationware and focuses more on providing a customised,
 self-administered interface for Mercurial_ and Git_ repositories. Kallithea
 works on Unix-like systems and Windows, and is powered by the vcs_ library
 created by Łukasz Balcerzak and Marcin Kuźmiński to uniformly handle multiple
 version control systems.
 Kallithea was forked from RhodeCode in July 2014 and has been heavily modified.
 Installation
 ------------
 Kallithea requires Python_ 2.x and it is recommended to install it in a
 virtualenv_. Official releases of Kallithea can be installed with::
     pip install kallithea
 The development repository is kept very stable and used in production by the
 developers - you can do the same.
+developers -- you can do the same.
 Please visit https://docs.kallithea-scm.org/en/latest/installation.html for
 more details.
 Source code
 -----------
 The latest sources can be obtained from
 https://kallithea-scm.org/repos/kallithea.
 The issue tracker and a repository mirror can be found at Bitbucket_ on
 https://bitbucket.org/conservancy/kallithea.
 Kallithea features
 ------------------
 - Has its own middleware to handle Mercurial_ and Git_ protocol requests. Each
   request is authenticated and logged together with IP address.
 - Built for speed and performance. You can make multiple pulls/pushes
   simultaneously. Proven to work with thousands of repositories and users.
 - Supports http/https, LDAP, AD, proxy-pass authentication.
 - Full permissions (private/read/write/admin) together with IP restrictions for
@@ @@ -94,53 +95,53 @@ Kallithea features @@
   location.
 - Based on Pylons, SQLAlchemy, SQLite, Whoosh, vcs.
 License
 -------
 **Kallithea** is released under the GPLv3 license. Kallithea is a `Software
 Freedom Conservancy`_ project and thus controlled by a non-profit organization.
 No commercial entity can take ownership of the project and change the
 direction.
 Kallithea started out as an effort to make sure the existing GPLv3 codebase
 would stay available under a legal license. Kallithea thus has to stay GPLv3
 compatible ... but we are also happy it is GPLv3 and happy to keep it that way.
 A different license (such as AGPL) could perhaps help attract a different
 community with a different mix of Free Software people and companies but we are
 happy with the current focus.
 Community
 ---------
 **Kallithea** is maintained by its users who contribute the fixes they would
- like to see.
 like to see.
 Get in touch with the rest of the community:
 - Join the mailing list users and developers - see
+- Join the mailing list users and developers -- see
   http://lists.sfconservancy.org/mailman/listinfo/kallithea-general.
 - Use IRC and join #kallithea on FreeNode (irc.freenode.net) or use
   http://webchat.freenode.net/?channels=kallithea.
 - Follow Kallithea on Twitter, **@KallitheaSCM**.
 - Issues can be reported at `issue tracker
   <https://bitbucket.org/conservancy/kallithea/issues>`_.
    .. note::
        Please try to read the documentation before posting any issues,
        especially the **troubleshooting section**
 Online documentation
 --------------------
 Online documentation for the current version of Kallithea is available at
 https://pythonhosted.org/Kallithea/. Documentation for the current development
 version can be found on https://docs.kallithea-scm.org/.
 You can also build the documentation locally: go to ``docs/`` and run::
@@ @@ -177,35 +178,36 @@ via:: @@
    python setup.py install
 then you will find this location at
 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``.
 One-time conversion
 ~~~~~~~~~~~~~~~~~~~
 Alternatively, if you would like to convert the database for good, you can use
 a helper script provided by Kallithea. This script will operate directly on the
 database, using the database string you can find in your ``production.ini`` (or
 ``development.ini``) file. For example, if using SQLite::
    cd /path/to/kallithea
    cp /path/to/rhodecode/rhodecode.db kallithea.db
    pip install sqlalchemy-migrate
    python kallithea/bin/rebranddb.py sqlite:///kallithea.db
 .. Note::
    If you started out using the branding interoperability approach mentioned
    above, watch out for stray brand.pyc after removing brand.py.
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _Python: http://www.python.org/
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _Mercurial: http://mercurial.selenic.com/
 .. _Bitbucket: http://bitbucket.org/
 .. _GitHub: http://github.com/
 .. _Subversion: http://subversion.tigris.org/
 .. _Git: http://git-scm.com/
 .. _Celery: http://celeryproject.org/
 .. _vcs: http://pypi.python.org/pypi/vcs
 .. _Software Freedom Conservancy: http://sfconservancy.org/

docs/api/api.rst

➞

Show inline comments

 .. _api:
 ===
 API
 ===
 Kallithea has a simple JSON RPC API with a single schema for calling all API
 methods. Everything is available by sending JSON encoded http(s) requests to
-<your_server>/_admin/api .
+``<your_server>/_admin/api``.
 API access for web views
 ++++++++++++++++++++++++
 API access can also be turned on for each web view in Kallithea that is
 decorated with the ``@LoginRequired`` decorator. Some views use
 ``@LoginRequired(api_access=True)`` and are always available. By default only
 RSS/ATOM feed views are enabled. Other views are
 only available if they have been white listed. Edit the
 RSS/Atom feed views are enabled. Other views are
 only available if they have been whitelisted. Edit the
 ``api_access_controllers_whitelist`` option in your .ini file and define views
 that should have API access enabled.
 For example, to enable API access to patch/diff raw file and archive::
+For example, to enable API access to patch/diff, raw file and archive::
     api_access_controllers_whitelist =
         ChangesetController:changeset_patch,
         ChangesetController:changeset_raw,
         FilesController:raw,
         FilesController:archivefile
 After this change, a Kallithea view can be accessed without login by adding a
 GET parameter ``?api_key=<api_key>`` to the URL.
 Exposing raw diffs is a good way to integrate with
-rd party services like code review, or build farms that could download archives.
+third-party services like code review, or build farms that can download archives.
 API access
 ++++++++++
 Clients must send JSON encoded JSON-RPC requests::
+    {
         "id: "<id>",
         "api_key": "<api_key>",
         "method": "<method_name>",
         "args": {"<arg_key>": "<arg_val>"}
+    }
 For example, to pull to a local "CPython" mirror using curl::
     curl https://server.com/_admin/api -X POST -H 'content-type:text/plain' --data-binary '{"id":1,"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}'
     curl https://example.com/_admin/api -X POST -H 'content-type:text/plain' \
         --data-binary '{"id":1,"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}'
 In general, provide
  - *id*, a value of any type, can be used to match the response with the request that it is replying to.
  - *api_key*, for authentication and permission validation.
  - *method*, the name of the method to call - a list of available methods can be found below.
+ - *method*, the name of the method to call -- a list of available methods can be found below.
  - *args*, the arguments to pass to the method.
 .. note::
     api_key can be found or set on the user account page
+    api_key can be found or set on the user account page.
 The response to the JSON-RPC API call will always be a JSON structure::
+    {
         "id":<id>, # the id that was used in the request
         "result": "<result>"|null, # JSON formatted result, null if any errors
         "error": "null"|<error_message> # JSON formatted error (if any)
         "id": <id>,  # the id that was used in the request
         "result": <result>|null,  # JSON formatted result (null on error)
         "error": null|<error_message>  # JSON formatted error (null on success)
+    }
-All responses from API will be ``HTTP/1.0 200 OK``. If there is an error,
+All responses from the API will be ``HTTP/1.0 200 OK``. If an error occurs,
 the reponse will have a failure description in *error* and
 *result* will be null.
 API client
 ++++++++++
 Kallithea comes with a ``kallithea-api`` command line tool providing a convenient
+Kallithea comes with a ``kallithea-api`` command line tool, providing a convenient
 way to call the JSON-RPC API.
 For example, to call ``get_repo``::
  kallithea-api --apihost=<your.kallithea.server.url> --apikey=<yourapikey> get_repo
  calling {"api_key": "<apikey>", "id": 75, "args": {}, "method": "get_repo"} to http://127.0.0.1:5000
  Kallithea said:
  {'error': 'Missing non optional `repoid` arg in JSON DATA',
   'id': 75,
   'result': None}
 Oops, looks like we forgot to add an argument. Let's try again, now
 providing the ``repoid`` as a parameter::
     kallithea-api get_repo repoid:myrepo
     calling {"api_key": "<apikey>", "id": 39, "args": {"repoid": "myrepo"}, "method": "get_repo"} to http://127.0.0.1:5000
     Kallithea said:
     {'error': None,
      'id': 39,
      'result': <json data...>}
 To avoid specifying ``apihost`` and ``apikey`` every time, run::
   kallithea-api --save-config --apihost=<your.kallithea.server.url> --apikey=<yourapikey>
-This will create a ``~/.config/kallithea`` with the specified hostname and apikey
+This will create a ``~/.config/kallithea`` with the specified hostname and API key
 so you don't have to specify them every time.
 API methods
 +++++++++++
 pull
 ----
 Pull the given repo from remote location. Can be used to automatically keep
 remote repos up to date.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "pull"
     args :    {
                 "repoid" : "<reponame or repo_id>"
+              }
 OUTPUT::
@@ @@ -311,91 +312,97 @@ INPUT:: @@
 OUTPUT::
     id : <id_given_in_input>
     result: [
+              {
                 "user_id" :     "<user_id>",
                 "api_key" :     "<api_key>",
                 "username" :    "<username>",
                 "firstname":    "<firstname>",
                 "lastname" :    "<lastname>",
                 "email" :       "<email>",
                 "emails":       "<list_of_all_additional_emails>",
                 "ip_addresses": "<list_of_ip_addresses_for_user>",
                 "active" :      "<bool>",
                 "admin" :       "<bool>",
                 "ldap_dn" :     "<ldap_dn>",
                 "last_login":   "<last_login>",
               },
               …
+            ]
     error:  null
 .. _create-user:
 create_user
 -----------
 Create new user.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "create_user"
     args :    {
                 "username" :  "<username>",
                 "email" :     "<useremail>",
                 "password" :  "<password = Optional(None)>",
                 "firstname" : "<firstname> = Optional(None)",
                 "lastname" :  "<lastname> = Optional(None)",
                 "active" :    "<bool> = Optional(True)",
                 "admin" :     "<bool> = Optional(False)",
                 "ldap_dn" :   "<ldap_dn> = Optional(None)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg" : "created new user `<username>`",
               "user": {
                 "user_id" :  "<user_id>",
                 "username" : "<username>",
                 "firstname": "<firstname>",
                 "lastname" : "<lastname>",
                 "email" :    "<email>",
                 "emails":    "<list_of_all_additional_emails>",
                 "active" :   "<bool>",
                 "admin" :    "<bool>",
                 "ldap_dn" :  "<ldap_dn>",
                 "last_login": "<last_login>",
               },
+            }
     error:  null
 Example::
     kallithea-api create_user username:bent email:bent@example.com firstname:Bent lastname:Bentsen extern_type:ldap extern_name:uid=bent,dc=example,dc=com
 update_user
 -----------
 Update the given user if such user exists.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "update_user"
     args :    {
                 "userid" : "<user_id or username>",
                 "username" :  "<username> = Optional(None)",
                 "email" :     "<useremail> = Optional(None)",
                 "password" :  "<password> = Optional(None)",
                 "firstname" : "<firstname> = Optional(None)",
                 "lastname" :  "<lastname> = Optional(None)",
                 "active" :    "<bool> = Optional(None)",
                 "admin" :     "<bool> = Optional(None)",
                 "ldap_dn" :   "<ldap_dn> = Optional(None)"
+              }

docs/changelog.rst

➞

Show inline comments

 .. _changelog:
 =========
 Changelog
 =========
-Kallithea project doesn't keep its changelog here.  We refer you to our Mercurial logs_ .
+Kallithea project doesn't keep its changelog here.  We refer you to our `Mercurial logs`__.
-.. _logs: https://kallithea-scm.org/repos/kallithea/changelog
+.. __: https://kallithea-scm.org/repos/kallithea/changelog

docs/conf.py

➞

Show inline comments

@@ @@ -67,48 +67,49 @@ release = __version__ @@
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build']
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 #add_module_names = True
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
 #show_authors = False
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 highlight_language = 'none'
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 # -- Options for HTML output ---------------------------------------------------
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = 'nature'
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #html_theme_options = {}
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ['theme']
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 #html_title = None
 # A shorter title for the navigation bar.  Default is the same as html_title.

docs/contributing.rst

➞

Show inline comments

 .. _contributing:
 =========================
 Contributing to Kallithea
 =========================
 Kallithea is developed and maintained by its users. Please join us and scratch
 your own itch.
 Infrastructure
 --------------
 The main repository is hosted at Our Own Kallithea (aka OOK) on
 https://kallithea-scm.org/repos/kallithea/ (which is our self-hosted instance
 of Kallithea).
 The main repository is hosted on Our Own Kallithea (aka OOK) at
 https://kallithea-scm.org/repos/kallithea/, our self-hosted instance
 of Kallithea.
 For now, we use Bitbucket_ for `Pull Requests`_ and `Issue Tracker`_ services. The
 issue tracker is for tracking bugs, not for support, discussion, or ideas -
 please use the `mailing list`_ to reach the community.
 For now, we use Bitbucket_ for `pull requests`_ and `issue tracking`_. The
 issue tracker is for tracking bugs, not for support, discussion, or ideas --
 please use the `mailing list`_ or :ref:`IRC <readme>` to reach the community.
 We use Weblate_ to translate the user interface messages into languages other
 than English. Join our project on `Hosted Weblate`_ to help us.
 To register, you can use your Bitbucket or GitHub account. See :ref:`translations`
 for more details.
 Getting started
 ---------------
 To get started with development::
         hg clone https://kallithea-scm.org/repos/kallithea
         cd kallithea
         virtualenv ../kallithea-venv
         source ../kallithea-venv/bin/activate
         python setup.py develop
         paster make-config Kallithea my.ini
         paster setup-db my.ini --user=user --email=user@example.com --password=password --repos=/tmp
         paster serve my.ini --reload &
         firefox http://127.0.0.1:5000/
 You can also start out by forking https://bitbucket.org/conservancy/kallithea
 on Bitbucket_ and create a local clone of your own fork.
 Running tests
 -------------
 After finishing your changes make sure all tests pass cleanly. You can run
 the testsuite running ``nosetests`` from the project root, or if you use tox
-run ``tox`` for python2.6-2.7 with multiple database test.
+run ``tox`` for Python 2.6--2.7 with multiple database test.
 When running tests, Kallithea uses `kallithea/tests/test.ini` and populates the
 SQLite database specified there.
 It is possible to avoid recreating the full test database on each invocation of
 the tests, thus eliminating the initial delay. To achieve this, run the tests as::
     paster serve kallithea/tests/test.ini --pid-file=test.pid --daemon
     KALLITHEA_WHOOSH_TEST_DISABLE=1 KALLITHEA_NO_TMP_PATH=1 nosetests
     kill -9 $(cat test.pid)
 You can run individual tests by specifying their path as argument to nosetests.
 nosetests also has many more options, see `nosetests -h`. Some useful options
 are::
     -x, --stop            Stop running tests after the first error or failure
     -s, --nocapture       Don't capture stdout (any stdout output will be
                           printed immediately) [NOSE_NOCAPTURE]
     --failed              Run the tests that failed in the last test run.
 Coding/contribution guidelines
 ------------------------------
 Kallithea is GPLv3 and we assume all contributions are made by the
 committer/contributor and under GPLv3 unless explicitly stated. We do care a
 lot about preservation of copyright and license information for existing code
 that is brought into the project.
 We don't have a formal coding/formatting standard. We are currently using a mix
 of Mercurial (http://mercurial.selenic.com/wiki/CodingStyle), pep8, and
 consistency with existing code. Run whitespacecleanup.sh to avoid stupid
 whitespace noise in your patches.
 We support both Python 2.6.x and 2.7.x and nothing else. For now we don't care
 about Python 3 compatibility.
 We try to support the most common modern web browsers. IE9 is still supported
 to the extent it is feasible, IE8 is not.
 We primarily support Linux and OS X on the server side but Windows should also work.
-Html templates should use 2 spaces for indentation ... but be pragmatic. We
+HTML templates should use 2 spaces for indentation ... but be pragmatic. We
 should use templates cleverly and avoid duplication. We should use reasonable
-semantic markup with classes and ids that can be used for styling and testing.
+semantic markup with element classes and IDs that can be used for styling and testing.
 We should only use inline styles in places where it really is semantic (such as
 display:none).
+``display: none``).
 JavaScript must use ';' between/after statements. Indentation 4 spaces. Inline
 multiline functions should be indented two levels - one for the () and one for
 {}. jQuery value arrays should have a leading $.
 JavaScript must use ``;`` between/after statements. Indentation 4 spaces. Inline
 multiline functions should be indented two levels -- one for the ``()`` and one for
 ``{}``.
 Variables holding jQuery objects should be named with a leading ``$``.
 Commit messages should have a leading short line summarizing the changes. For
-bug fixes, put "(Issue #123)" at the end of this line.
+bug fixes, put ``(Issue #123)`` at the end of this line.
 Contributions will be accepted in most formats - such as pull requests on
+Contributions will be accepted in most formats -- such as pull requests on
 bitbucket, something hosted on your own Kallithea instance, or patches sent by
 email to the kallithea-general mailing list.
+email to the `kallithea-general`_ mailing list.
 Make sure to test your changes both manually and with the automatic tests
 before posting.
 We care about quality and review and keeping a clean repository history. We
 might give feedback that requests polishing contributions until they are
 "perfect". We might also rebase and collapse and make minor adjustments to your
 changes when we apply them.
 We try to make sure we have consensus on the direction the project is taking.
 Everything non-sensitive should be discussed in public - preferably on the
+Everything non-sensitive should be discussed in public -- preferably on the
 mailing list.  We aim at having all non-trivial changes reviewed by at least
 one other core developer before pushing. Obvious non-controversial changes will
 be handled more casually.
 For now we just have one official branch ("default") and will keep it so stable
 that it can be (and is) used in production. Experimental changes should live
 elsewhere (for example in a pull request) until they are ready.
 .. _translations:
 .. include:: ./../kallithea/i18n/how_to
 "Roadmap"
 ---------
 We do not have a road map but are waiting for your contributions. Refer to the
 wiki_ for some ideas of places we might want to go - contributions in these
+wiki_ for some ideas of places we might want to go -- contributions in these
 areas are very welcome.
 Thank you for your contribution!
 --------------------------------
 .. _Weblate: http://weblate.org/
 .. _Issue Tracker: https://bitbucket.org/conservancy/kallithea/issues?status=new&status=open
 .. _Pull Requests: https://bitbucket.org/conservancy/kallithea/pull-requests
 .. _issue tracking: https://bitbucket.org/conservancy/kallithea/issues?status=new&status=open
 .. _pull requests: https://bitbucket.org/conservancy/kallithea/pull-requests
 .. _bitbucket: http://bitbucket.org/
 .. _mailing list: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general
 .. _kallithea-general: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general
 .. _Hosted Weblate: https://hosted.weblate.org/projects/kallithea/kallithea/
 .. _wiki: https://bitbucket.org/conservancy/kallithea/wiki/Home

docs/installation.rst

➞

Show inline comments

 .. _installation:
 ==========================
 Installation on Unix/Linux
 ==========================
-Here are more details about 3 ways to install Kallithea:
+The following describes three different ways of installing Kallithea:
 - :ref:`installation-source`: The simplest way to keep the installation
   uptodate and keep track of local customizations is to run directly from
   source in a Kallithea repository clone and use virtualenv.
   up-to-date and track any local customizations is to run directly from
   source in a Kallithea repository clone, preferably inside a virtualenv
   virtual Python environment.
 - :ref:`installation-virtualenv`: If you prefer to only use released versions
   of Kallithea, the recommended method is to install Kallithea in a virtual
   Python environment using `virtualenv`. The advantages of this method over
   direct installation is that Kallithea and its dependencies are completely
   contained inside the virtualenv (which also means you can have multiple
   installations side by side or remove it entirely by just removing the
   virtualenv directory) and does not require root privileges.
 - :ref:`installation-without-virtualenv`: The alternative method of installing
   a Kallithea release is using standard pip. The package will be installed in
   the same location as all other Python packages you have ever installed. As a
   result, removing it is not as straightforward as with a virtualenv, as you'd
   have to remove its dependencies manually and make sure that they are not
   needed by other packages.
 .. _installation-source:
 Installation from repository source
 -----------------------------------
-To install Kallithea in a virtualenv using the stable branch of the development
+To install Kallithea in a virtualenv_ using the stable branch of the development
 repository, follow the instructions below::
         hg clone https://kallithea-scm.org/repos/kallithea -u stable
         cd kallithea
         virtualenv ../kallithea-venv
         source ../kallithea-venv/bin/activate
         python setup.py develop
         python setup.py compile_catalog   # for translation of the UI
 You can now proceed to :ref:`setup`.
 To upgrade, simply update the repository with ``hg pull -u`` and restart the
 server.
 .. _installation-virtualenv:
 Installing a released version in a virtualenv
 ---------------------------------------------
 It is highly recommended to use a separate virtualenv_ for installing Kallithea.
 This way, all libraries required by Kallithea will be installed separately from your
 main Python installation and other applications and things will be less
 problematic when upgrading the system or Kallithea.
 An additional benefit of virtualenv_ is that it doesn't require root privileges.

docs/installation_iis.rst

➞

Show inline comments

 .. _installation_iis:
 =====================================================================
 Installing Kallithea on Microsoft Internet Information Services (IIS)
 =====================================================================
 The following is documented using IIS 7/8 terminology. There should be nothing
 preventing you from applying this on IIS 6 well.
 .. note::
     For the best security, it is strongly recommended to only host the site over
     a secure connection, e.g. using TLS.
 Prerequisites
 -------------
 Apart from the normal requirements for Kallithea, it is also necessary to get an
 ISAPI-WSGI bridge module, e.g. isapi-wsgi.
 Installation
 ------------
-The following will assume that your Kallithea is at ``c:\inetpub\kallithea`` and
+The following assumes that your Kallithea is at ``c:\inetpub\kallithea``, and
 will be served from the root of its own website. The changes to serve it in its
 own virtual folder will be noted where appropriate.
 Application pool
 ................
 Make sure that there is a unique application pool for the Kallithea application
 with an identity that has read access to the Kallithea distribution.
 The application pool does not need to be able to run any managed code. If you
 are using a 32-bit Python installation, then you must enable 32 bit program in
 the advanced settings for the application pool otherwise Python will not be able
 to run on the website and consequently, Kallithea will not be able to run.
 are using a 32-bit Python installation, then you must enable 32-bit program in
 the advanced settings for the application pool; otherwise Python will not be able
 to run on the website and neither will Kallithea.
 .. note::
     The application pool can be the same as an existing application pool as long
     as the requirements to Kallithea are enabled by the existing application
     pool.
     The application pool can be the same as an existing application pool,
     as long as the Kallithea requirements are met by the existing pool.
 ISAPI handler
 .............
 The ISAPI handler can be generated using::
     paster install-iis my.ini --root=/
 This will generate a ``dispatch.py`` file in the current directory that contains
 the necessary components to finalize an installation into IIS. Once this file
 has been generated, it is necessary to run the following command due to the way
 that ISAPI-WSGI is made::
     python dispatch.py install
 This accomplishes two things: generating an ISAPI compliant DLL file,
 ``_dispatch.dll``, and installing a script map handler into IIS for the
 ``--root`` specified above pointing to ``_dispatch.dll``.
 The ISAPI handler is registered to all file extensions, so it will automatically
 be the one handling all requests to the specified root. When the website starts
 the ISAPI handler, it will start a thread pool managed wrapper around the paster
 middleware WSGI handler that Kallithea runs within and each HTTP request to the
 site will be processed through this logic henceforth.

docs/installation_win_old.rst

➞

Show inline comments

 .. _installation_win_old:
 ======================================================================
 Installation and upgrade on Windows (XP/Vista/Server 2003/Server 2008)
 ======================================================================
 First-time install
 ::::::::::::::::::
-Target OS: Windows XP SP3 32bit English (Clean installation)
+Target OS: Windows XP SP3 32-bit English (Clean installation)
 + All Windows Updates until 24-may-2012
 .. note::
    This installation is for 32bit systems, for 64bit windows you might need
    to download proper 64bit versions of the different packages(Windows Installer, Win32py extensions)
    This installation is for 32-bit systems, for 64-bit Windows you might need
    to download proper 64-bit versions of the different packages (Windows Installer, Win32py extensions)
    plus some extra tweaks.
-   These extra steps haven been marked as "64bit".
+   These extra steps haven been marked as "64-bit".
    Tested on Windows Server 2008 R2 SP1, 9-feb-2013.
-   If you run into any 64bit related problems, please check these pages:
+   If you run into any 64-bit related problems, please check these pages:
    - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/
    - http://bugs.python.org/issue7511
 Step 1 - Install Visual Studio 2008 Express
 -------------------------------------------
 Optional: You can also install MinGW, but VS2008 installation is easier.
 Download "Visual C++ 2008 Express Edition with SP1" from:
 http://download.microsoft.com/download/E/8/E/E8EEB394-7F42-4963-A2D8-29559B738298/VS2008ExpressWithSP1ENUX1504728.iso
 (if not found or relocated, google for "visual studio 2008 express" for updated link. This link was taken from http://stackoverflow.com/questions/15318560/visual-c-2008-express-download-link-dead)
 You can also download full ISO file for offline installation, just
 choose "All - Offline Install ISO image file" in the previous page and
 choose "Visual C++ 2008 Express" when installing.
 .. note::
    Using other versions of Visual Studio will lead to random crashes.
    You must use Visual Studio 2008!"
 .. note::
    Silverlight Runtime and SQL Server 2008 Express Edition are not
    required, you can uncheck them
 .. note::
-bit: You also need to install the Microsoft Windows SDK for .NET 3.5 SP1 (.NET 4.0 won't work).
+-bit: You also need to install the Microsoft Windows SDK for .NET 3.5 SP1 (.NET 4.0 won't work).
    Download from: http://www.microsoft.com/en-us/download/details.aspx?id=3138
 .. note::
 bit: You also need to copy and rename a .bat file to make the Visual C++ compiler work.
    I am not sure why this is not necessary for 32bit.
 -bit: You also need to copy and rename a .bat file to make the Visual C++ compiler work.
    I am not sure why this is not necessary for 32-bit.
    Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
 Step 2 - Install Python
 -----------------------
 Step 2 -- Install Python
 ------------------------
-Install Python 2.x.y (x = 6 or 7) x86 version (32bit). DO NOT USE A 3.x version.
+Install Python 2.x.y (x = 6 or 7) x86 version (32-bit). DO NOT USE A 3.x version.
 Download Python 2.x.y from:
 http://www.python.org/download/
-Choose "Windows Installer" (32bit version) not "Windows X86-64
+Choose "Windows Installer" (32-bit version) not "Windows X86-64
 Installer". While writing this guide, the latest version was v2.7.3.
 Remember the specific major and minor version installed, because it will
 be needed in the next step. In this case, it is "2.7".
 .. note::
 bit: Just download and install the 64bit version of python.
 -bit: Just download and install the 64-bit version of python.
 Step 3 - Install Win32py extensions
 -----------------------------------
 Step 3 -- Install Win32py extensions
 ------------------------------------
 Download pywin32 from:
 http://sourceforge.net/projects/pywin32/files/
 - Click on "pywin32" folder
 - Click on the first folder (in this case, Build 217, maybe newer when you try)
 - Choose the file ending with ".win32-py2.x.exe" -> x being the minor
   version of Python you installed (in this case, 7)
   When writing this guide, the file was:
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20217/pywin32-217.win32-py2.7.exe/download
   .. note::
-bit: Download and install the 64bit version.
+-bit: Download and install the 64-bit version.
      At the time of writing you can find this at:
      http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
 Step 4 - Python BIN
 -------------------
 Step 4 -- Python BIN
 --------------------
 Add Python BIN folder to the path
 You have to add the Python folder to the path, you can do it manually
 (editing "PATH" environment variable) or using Windows Support Tools
 that came preinstalled in Vista/7 and can be installed in Windows XP.
 - Using support tools on WINDOWS XP:
   If you use Windows XP you can install them using Windows XP CD and
   navigating to \SUPPORT\TOOLS. There, execute Setup.EXE (not MSI).
   Afterwards, open a CMD and type::
     SETX PATH "%PATH%;[your-python-path]" -M
   Close CMD (the path variable will be updated then)
 - Using support tools on WINDOWS Vista/7:
   Open a CMD and type::
     SETX PATH "%PATH%;[your-python-path]" /M
   Please substitute [your-python-path] with your Python installation path.
   Typically: C:\\Python27
 Step 5 - Kallithea folder structure
 -----------------------------------
 Step 5 -- Kallithea folder structure
 ------------------------------------
 Create a Kallithea folder structure
 This is only a example to install Kallithea, you can of course change
 it. However, this guide will follow the proposed structure, so please
 later adapt the paths if you change them. My recommendation is to use
 folders with NO SPACES. But you can try if you are brave...
 Create the following folder structure::
   C:\Kallithea
   C:\Kallithea\Bin
   C:\Kallithea\Env
   C:\Kallithea\Repos
 Step 6 - Install virtualenv
 ---------------------------
 Step 6 -- Install virtualenv
 ----------------------------
 Install Virtual Env for Python
 Navigate to: http://www.virtualenv.org/en/latest/index.html#installation
 Right click on "virtualenv.py" file and choose "Save link as...".
 Download to C:\\Kallithea (or whatever you want)
 (the file is located at
 https://raw.github.com/pypa/virtualenv/master/virtualenv.py)
 Create a virtual Python environment in C:\\Kallithea\\Env (or similar). To
 do so, open a CMD (Python Path should be included in Step3), navigate
 where you downloaded "virtualenv.py", and write::
  python virtualenv.py C:\Kallithea\Env
 (--no-site-packages is now the default behaviour of virtualenv, no need
 to include it)
 Step 7 - Install Kallithea
 --------------------------
 Step 7 -- Install Kallithea
 ---------------------------
 Finally, install Kallithea
 Close previously opened command prompt/s, and open a Visual Studio 2008
 Command Prompt (**IMPORTANT!!**). To do so, go to Start Menu, and then open
 "Microsoft Visual C++ 2008 Express Edition" -> "Visual Studio Tools" ->
 "Visual Studio 2008 Command Prompt"
 .. note::
-bit: For 64bit you need to modify the shortcut that is used to start the
+-bit: For 64-bit you need to modify the shortcut that is used to start the
    Visual Studio 2008 Command Prompt. Use right-mouse click to open properties.
 Change commandline from::
 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" x86
 to::
 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" amd64
 In that CMD (loaded with VS2008 PATHs) type::
   cd C:\Kallithea\Env\Scripts (or similar)
   activate
 The prompt will change into "(Env) C:\\Kallithea\\Env\\Scripts" or similar
 (depending of your folder structure). Then type::
  pip install kallithea
 (long step, please wait until fully complete)
 Some warnings will appear, don't worry as they are normal.
 Step 8 - Configuring Kallithea
 ------------------------------
 Step 8 -- Configuring Kallithea
 -------------------------------
 steps taken from http://packages.python.org/Kallithea/setup.html
 You have to use the same Visual Studio 2008 command prompt as Step7, so
 if you closed it reopen it following the same commands (including the
 "activate" one). When ready, just type::
   cd C:\Kallithea\Bin
   paster make-config Kallithea production.ini
 Then, you must edit production.ini to fit your needs (network address and
 port, mail settings, database, whatever). I recommend using NotePad++
 (free) or similar text editor, as it handles well the EndOfLine
 character differences between Unix and Windows
 (http://notepad-plus-plus.org/)
 For the sake of simplicity lets run it with the default settings. After
 your edits (if any), in the previous Command Prompt, type::
  paster setup-db production.ini
 (this time a NEW database will be installed, you must follow a different
 step to later UPGRADE to a newer Kallithea version)
 The script will ask you for confirmation about creating a NEW database,
 answer yes (y)
 The script will ask you for repository path, answer C:\\Kallithea\\Repos
 (or similar)
 The script will ask you for admin username and password, answer "admin"
 + "123456" (or whatever you want)
 The script will ask you for admin mail, answer "admin@xxxx.com" (or
 whatever you want)
 If you make some mistake and the script does not end, don't worry, start
 it again.
 Step 9 - Running Kallithea
 --------------------------
 Step 9 -- Running Kallithea
 ---------------------------
 In the previous command prompt, being in the C:\\Kallithea\\Bin folder,
 just type::
  paster serve production.ini
 Open yout web server, and go to http://127.0.0.1:5000
 It works!! :-)
 Remark:
 If it does not work first time, just Ctrl-C the CMD process and start it
 again. Don't forget the "http://" in Internet Explorer
 What this Guide does not cover:
 - Installing Celery
 - Running Kallithea as Windows Service. You can investigate here:
   - http://pypi.python.org/pypi/wsgisvc
   - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/

docs/setup.rst

➞

Show inline comments

 .. _setup:
 =====
 Setup
 =====
 Setting up Kallithea
 --------------------
 First, you will need to create a Kallithea configuration file. Run the
 following command to do so::
     paster make-config Kallithea my.ini
 This will create the file ``my.ini`` in the current directory. This
-configuration file contains the various settings for Kallithea, e.g.,
 configuration file contains the various settings for Kallithea, e.g.
 proxy port, email settings, usage of static files, cache, Celery
 settings, and logging.
 Next, you need to create the databases used by Kallithea. It is recommended to
 use PostgreSQL or SQLite (default). If you choose a database other than the
 default, ensure you properly adjust the database URL in your ``my.ini``
 configuration file to use this other database. Kallithea currently supports
 PostgreSQL, SQLite and MySQL databases. Create the database by running
 the following command::
     paster setup-db my.ini
 This will prompt you for a "root" path. This "root" path is the location where
 Kallithea will store all of its repositories on the current machine. After
 entering this "root" path ``setup-db`` will also prompt you for a username
 and password for the initial admin account which ``setup-db`` sets
 up for you.
 The setup process can be fully automated, example for lazy::
 The ``setup-db`` values can also be given on the command line.
 Example::
-    paster setup-db my.ini --user=nn --password=secret --email=nn@your.kallithea.server --repos=/srv/repos
+    paster setup-db my.ini --user=nn --password=secret --email=nn@example.org --repos=/srv/repos
-The ``setup-db`` command will create all of the needed tables and an
 The ``setup-db`` command will create all needed tables and an
 admin account. When choosing a root path you can either use a new
 empty location, or a location which already contains existing
 repositories. If you choose a location which contains existing
 repositories Kallithea will add all of the repositories at the chosen
 location to its database.  (Note: make sure you specify the correct
 path to the root).
 .. note:: the given path for Mercurial_ repositories **must** be write
           accessible for the application. It's very important since
           the Kallithea web interface will work without write access,
           but when trying to do a push it will fail with permission
           denied errors unless it has write access.
 You are now ready to use Kallithea. To run it simply execute::
     paster serve my.ini
 - This command runs the Kallithea server. The web app should be available at
   http://127.0.0.1:5000. This ip and port is configurable via the my.ini
   file created in previous step
 - Use the admin account you created above when running ``setup-db``
   to login to the web app.
   http://127.0.0.1:5000. The IP address and port is configurable via the
   configuration file created in the previous step.
 - Log in to Kallithea using the admin account created when running ``setup-db``.
 - The default permissions on each repository is read, and the owner is admin.
   Remember to update these if needed.
 - In the admin panel you can toggle LDAP, anonymous, and permissions
   settings, as well as edit more advanced options on users and
   repositories
+  repositories.
 Extensions
 ----------
 Optionally users can create an ``rcextensions`` package that extends Kallithea
 functionality. To do this simply execute::
 Optionally one can create an ``rcextensions`` package that extends Kallithea
 functionality.
 To generate a skeleton extensions package, run::
     paster make-rcext my.ini
 This will create an ``rcextensions`` package next to the specified ``ini`` file.
 With ``rcextensions`` it's possible to add additional mapping for whoosh,
 stats and add additional code into the push/pull/create/delete repo hooks,
 for example for sending signals to build-bots such as Jenkins.
 See the ``__init__.py`` file inside the generated ``rcextensions`` package
 for more details.
 Using Kallithea with SSH
 ------------------------
 Kallithea currently only hosts repositories using http and https. (The addition
 of ssh hosting is a planned future feature.) However you can easily use ssh in
 parallel with Kallithea. (Repository access via ssh is a standard "out of
 the box" feature of Mercurial_ and you can use this to access any of the
 repositories that Kallithea is hosting. See PublishingRepositories_)
 Kallithea repository structures are kept in directories with the same name
 as the project. When using repository groups, each group is a subdirectory.
 This allows you to easily use ssh for accessing repositories.
@@ @@ -102,95 +103,88 @@ This allows you to easily use ssh for ac @@
 In order to use ssh you need to make sure that your web server and the users'
 login accounts have the correct permissions set on the appropriate directories.
 .. note:: These permissions are independent of any permissions you
           have set up using the Kallithea web interface.
 If your main directory (the same as set in Kallithea settings) is for
 example set to ``/srv/repos`` and the repository you are using is
 named ``kallithea``, then to clone via ssh you should run::
     hg clone ssh://user@server.com//srv/repos/kallithea
 Using other external tools such as mercurial-server_ or using ssh key-based
 authentication is fully supported.
 .. note:: In an advanced setup, in order for your ssh access to use
           the same permissions as set up via the Kallithea web
           interface, you can create an authentication hook to connect
           to the Kallithea db and run check functions for permissions
           against that.
 Setting up Whoosh full text search
 ----------------------------------
 The whoosh index can be built by using the paster
 command ``make-index``. To use ``make-index`` you must specify the configuration
 file that stores the location of the index. You may specify the location of the
 repositories (``--repo-location``).  If not specified, this value is retrieved
 from the Kallithea database.
 It is also possible to specify a comma separated list of
 repositories (``--index-only``) to build index only on chooses repositories
 skipping any other found in repos location
 Kallithea provides full text search of repositories using `Whoosh`__.
 You may optionally pass the option ``-f`` to enable a full index rebuild. Without
 the ``-f`` option, indexing will run always in "incremental" mode.
 .. __: https://pythonhosted.org/Whoosh/
-For an incremental index build use::
+For an incremental index build, run::
     paster make-index my.ini
-For a full index rebuild use::
+For a full index rebuild, run::
     paster make-index my.ini -f
 The ``--repo-location`` option allows the location of the repositories to be overriden;
 usually, the location is retrieved from the Kallithea database.
-Building an index for just selected repositories is possible with such command::
+The ``--index-only`` option can be used to limit the indexed repositories to a comma-separated list::
     paster make-index my.ini --index-only=vcs,kallithea
 In order to do periodic index builds and keep your index always up to
 date, it is recommended to use a crontab entry.  An example entry
 might look like this::
 To keep your index up-to-date it is necessary to do periodic index builds;
 for this, it is recommended to use a crontab entry. Example::
-    /path/to/python/bin/paster make-index /path/to/kallithea/my.ini
+3  *  *  *  /path/to/virtualenv/bin/paster make-index /path/to/kallithea/my.ini
-When using incremental mode (the default) whoosh will check the last
+When using incremental mode (the default), Whoosh will check the last
 modification date of each file and add it to be reindexed if a newer file is
 available. The indexing daemon checks for any removed files and removes them
 from index.
 If you want to rebuild the index from scratch, you can use the ``-f`` flag as above,
-or in the admin panel you can check the "build from scratch" flag.
+or in the admin panel you can check the "build from scratch" checkbox.
 Setting up LDAP support
 -----------------------
 Kallithea supports LDAP authentication. In order
 to use LDAP, you have to install the python-ldap_ package. This package is
-available via pypi, so you can install it by running::
+available via PyPI, so you can install it by running::
     pip install python-ldap
 .. note:: ``python-ldap`` requires some libraries to be installed on
           your system, so before installing it check that you have at
           least the ``openldap`` and ``sasl`` libraries.
 LDAP settings are located in the Admin->LDAP section.
 Here's a typical LDAP setup::
  Connection settings
  Enable LDAP          = checked
  Host                 = host.example.org
  Port                 = 389
  Account              = <account>
  Password             = <password>
  Connection Security  = LDAPS connection
  Certificate Checks   = DEMAND
  Search settings
  Base DN              = CN=users,DC=host,DC=example,DC=org
  LDAP Filter          = (&(objectClass=user)(!(objectClass=computer)))
  LDAP Search Scope    = SUBTREE
@@ @@ -357,162 +351,169 @@ Active Directory @@
 Kallithea can use Microsoft Active Directory for user authentication.  This
 is done through an LDAP or LDAPS connection to Active Directory.  The
 following LDAP configuration settings are typical for using Active
 Directory ::
  Base DN              = OU=SBSUsers,OU=Users,OU=MyBusiness,DC=v3sys,DC=local
  Login Attribute      = sAMAccountName
  First Name Attribute = givenName
  Last Name Attribute  = sn
  Email Attribute     = mail
 All other LDAP settings will likely be site-specific and should be
 appropriately configured.
 Authentication by container or reverse-proxy
 --------------------------------------------
 Kallithea supports delegating the authentication
 of users to its WSGI container, or to a reverse-proxy server through which all
 clients access the application.
 When these authentication methods are enabled in Kallithea, it uses the
-username that the container/proxy (Apache/Nginx/etc) authenticated and doesn't
+username that the container/proxy (Apache or Nginx, etc.) provides and doesn't
 perform the authentication itself. The authorization, however, is still done by
 Kallithea according to its settings.
 When a user logs in for the first time using these authentication methods,
 a matching user account is created in Kallithea with default permissions. An
 administrator can then modify it using Kallithea's admin interface.
 It's also possible for an administrator to create accounts and configure their
 permissions before the user logs in for the first time.
+permissions before the user logs in for the first time, using the :ref:`create-user` API.
 Container-based authentication
 ''''''''''''''''''''''''''''''
 In a container-based authentication setup, Kallithea reads the user name from
 the ``REMOTE_USER`` server variable provided by the WSGI container.
-After setting up your container (see `Apache's WSGI config`_), you'd need
+After setting up your container (see `Apache with mod_wsgi`_), you'll need
 to configure it to require authentication on the location configured for
 Kallithea.
 Proxy pass-through authentication
 '''''''''''''''''''''''''''''''''
 In a proxy pass-through authentication setup, Kallithea reads the user name
 from the ``X-Forwarded-User`` request header, which should be configured to be
 sent by the reverse-proxy server.
 After setting up your proxy solution (see `Apache virtual host reverse proxy example`_,
-`Apache as subdirectory`_ or `Nginx virtual host example`_), you'd need to
+`Apache as subdirectory`_ or `Nginx virtual host example`_), you'll need to
 configure the authentication and add the username in a request header named
 ``X-Forwarded-User``.
 For example, the following config section for Apache sets a subdirectory in a
 reverse-proxy setup with basic auth::
 reverse-proxy setup with basic auth:
 .. code-block:: apache
     <Location /<someprefix> >
       ProxyPass http://127.0.0.1:5000/<someprefix>
       ProxyPassReverse http://127.0.0.1:5000/<someprefix>
     <Location /someprefix>
       ProxyPass http://127.0.0.1:5000/someprefix
       ProxyPassReverse http://127.0.0.1:5000/someprefix
       SetEnvIf X-Url-Scheme https HTTPS=1
       AuthType Basic
       AuthName "Kallithea authentication"
       AuthUserFile /srv/kallithea/.htpasswd
-      require valid-user
+      Require valid-user
       RequestHeader unset X-Forwarded-User
       RewriteEngine On
       RewriteCond %{LA-U:REMOTE_USER} (.+)
       RewriteRule .* - [E=RU:%1]
       RequestHeader set X-Forwarded-User %{RU}e
     </Location>
 .. note::
    If you enable proxy pass-through authentication, make sure your server is
    only accessible through the proxy. Otherwise, any client would be able to
    forge the authentication header and could effectively become authenticated
    using any account of their liking.
 Integration with issue trackers
 -------------------------------
 Kallithea provides a simple integration with issue trackers. It's possible
 to define a regular expression that will fetch an issue id stored in a commit
 messages and replace that with a URL to the issue. To enable this simply
 to define a regular expression that will match an issue ID in commit messages,
 and have that replaced with a URL to the issue. To enable this simply
 uncomment the following variables in the ini file::
     issue_pat = (?:^#|\s#)(\w+)
     issue_server_link = https://myissueserver.com/{repo}/issue/{id}
     issue_prefix = #
 ``issue_pat`` is the regular expression describing which strings in
 commit messages will be treated as issue references. A match group in
 parentheses should be used to specify the actual issue id.
 The default expression matches issues in the format ``#<number>``, e.g., ``#300``.
 Matched issues are replaced with the link specified as
 ``issue_server_link`` ``{id}`` is replaced with issue id, and
 Matched issue references are replaced with the link specified in
 ``issue_server_link``. ``{id}`` is replaced with the issue ID, and
 ``{repo}`` with the repository name.  Since the # is stripped away,
 ``issue_prefix`` is prepended to the link text.  ``issue_prefix`` doesn't
 necessarily need to be ``#``: if you set issue prefix to ``ISSUE-`` this will
 generate a URL in the format::
 generate a URL in the format:
 .. code-block:: html
   <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a>
 If needed, more than one pattern can be specified by appending a unique suffix to
 the variables. For example::
     issue_pat_wiki = (?:wiki-)(.+)
     issue_server_link_wiki = https://mywiki.com/{id}
     issue_prefix_wiki = WIKI-
 With these settings, wiki pages can be referenced as wiki-some-id, and every
 such reference will be transformed into::
 such reference will be transformed into:
 .. code-block:: html
   <a href="https://mywiki.com/some-id">WIKI-some-id</a>
 Hook management
 ---------------
 Hooks can be managed in similar way to that used in ``.hgrc`` files.
 To access hooks setting click `advanced setup` in the `Hooks` section
 of Mercurial Settings in Admin.
 There are four built in hooks that cannot be changed (only enabled/disabled by
 checkboxes in the previous section).
 To add another custom hook simply fill in the first section with
 ``<name>.<hook_type>`` and the second one with hook path. Example hooks
 The built-in hooks cannot be modified, though they can be enabled or disabled in the *VCS* section.
 To add another custom hook simply fill in the first textbox with
 ``<name>.<hook_type>`` and the second with the hook path. Example hooks
 can be found in ``kallithea.lib.hooks``.
 Changing default encoding
 -------------------------
 By default, Kallithea uses UTF-8 encoding.
 This is configurable as ``default_encoding`` in the .ini file.
 This affects many parts in Kallithea including user names, filenames, and
 encoding of commit messages. In addition Kallithea can detect if the ``chardet``
 library is installed. If ``chardet`` is detected Kallithea will fallback to it
 when there are encode/decode errors.
 Celery configuration
 --------------------
 Kallithea can use the distributed task queue system Celery_ to run tasks like
 cloning repositories or sending emails.
 Kallithea will in most setups work perfectly fine out of the box (without
 Celery), executing all tasks in the web server process. Some tasks can however
 take some time to run and it can be better to run such tasks asynchronously in
 a separate process so the web server can focus on serving web requests.
@@ @@ -520,65 +521,70 @@ a separate process so the web server can @@
 For installation and configuration of Celery, see the `Celery documentation`_.
 Note that Celery requires a message broker service like RabbitMQ_ (recommended)
 or Redis_.
 The use of Celery is configured in the Kallithea ini configuration file.
 To enable it, simply set::
   use_celery = true
 and add or change the ``celery.*`` and ``broker.*`` configuration variables.
 Remember that the ini files use the format with '.' and not with '_' like
 Celery. So for example setting `BROKER_HOST` in Celery means setting
 `broker.host` in the configuration file.
 To start the Celery process, run::
  paster celeryd <configfile.ini>
 .. note::
    Make sure you run this command from the same virtualenv, and with the same
    user that Kallithea runs.
 HTTPS support
 -------------
 Kallithea will by default generate URLs based on the WSGI environment.
 Alternatively, you can use some special configuration settings to control
 directly which scheme/protocol Kallithea will use when generating URLs:
 - With ``https_fixup = true``, the scheme will be taken from the ``HTTP_X_URL_SCHEME``,
   ``HTTP_X_FORWARDED_SCHEME`` or ``HTTP_X_FORWARDED_PROTO HTTP`` header (default ``http``).
 - With ``https_fixup = true``, the scheme will be taken from the
   ``X-Url-Scheme``, ``X-Forwarded-Scheme`` or ``X-Forwarded-Proto`` HTTP header
   (default ``http``).
 - With ``force_https = true`` the default will be ``https``.
 - With ``use_htsts = true``, it will set ``Strict-Transport-Security`` when using https.
 - With ``use_htsts = true``, Kallithea will set ``Strict-Transport-Security`` when using https.
 Nginx virtual host example
 --------------------------
 Sample config for nginx using proxy::
 Sample config for Nginx using proxy:
 .. code-block:: nginx
     upstream kallithea {
         server 127.0.0.1:5000;
         # add more instances for load balancing
         #server 127.0.0.1:5001;
         #server 127.0.0.1:5002;
+    }
     ## gist alias
     server {
        listen          443;
        server_name     gist.myserver.com;
        access_log      /var/log/nginx/gist.access.log;
        error_log       /var/log/nginx/gist.error.log;
        ssl on;
        ssl_certificate     gist.your.kallithea.server.crt;
        ssl_certificate_key gist.your.kallithea.server.key;
        ssl_session_timeout 5m;
        ssl_protocols SSLv3 TLSv1;
        ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
        ssl_prefer_server_ciphers on;
@@ @@ -622,174 +628,192 @@ pushes or large pushes:: @@
     proxy_redirect              off;
     proxy_set_header            Host $host;
     ## needed for container auth
     #proxy_set_header            REMOTE_USER $remote_user;
     #proxy_set_header            X-Forwarded-User $remote_user;
     proxy_set_header            X-Url-Scheme $scheme;
     proxy_set_header            X-Host $http_host;
     proxy_set_header            X-Real-IP $remote_addr;
     proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header            Proxy-host $proxy_host;
     proxy_buffering             off;
     proxy_connect_timeout       7200;
     proxy_send_timeout          7200;
     proxy_read_timeout          7200;
     proxy_buffers               8 32k;
     client_max_body_size        1024m;
     client_body_buffer_size     128k;
     large_client_header_buffers 8 64k;
 Apache virtual host reverse proxy example
 -----------------------------------------
 Here is a sample configuration file for apache using proxy::
 Here is a sample configuration file for Apache using proxy:
 .. code-block:: apache
     <VirtualHost *:80>
             ServerName hg.myserver.com
             ServerAlias hg.myserver.com
             <Proxy *>
               Order allow,deny
               Allow from all
               # For Apache 2.4 and later:
               Require all granted
               # For Apache 2.2 and earlier, instead use:
               # Order allow,deny
               # Allow from all
             </Proxy>
             #important !
             #Directive to properly generate url (clone url) for pylons
             ProxyPreserveHost On
             #kallithea instance
             ProxyPass / http://127.0.0.1:5000/
             ProxyPassReverse / http://127.0.0.1:5000/
             #to enable https use line below
             #SetEnvIf X-Url-Scheme https HTTPS=1
     </VirtualHost>
 Additional tutorial
 http://pylonsbook.com/en/1.1/deployment.html#using-apache-to-proxy-requests-to-pylons
 Apache as subdirectory
 ----------------------
 Apache subdirectory part::
 Apache subdirectory part:
 .. code-block:: apache
     <Location /<someprefix> >
       ProxyPass http://127.0.0.1:5000/<someprefix>
       ProxyPassReverse http://127.0.0.1:5000/<someprefix>
       SetEnvIf X-Url-Scheme https HTTPS=1
     </Location>
 Besides the regular apache setup you will need to add the following line
 into ``[app:main]`` section of your .ini file::
     filter-with = proxy-prefix
 Add the following at the end of the .ini file::
     [filter:proxy-prefix]
     use = egg:PasteDeploy#prefix
     prefix = /<someprefix>
 then change ``<someprefix>`` into your chosen prefix
-Apache's WSGI config
+Apache with mod_wsgi
 --------------------
 Alternatively, Kallithea can be set up with Apache under mod_wsgi. For
 that, you'll need to:
 - Install mod_wsgi. If using a Debian-based distro, you can install
   the package libapache2-mod-wsgi::
     aptitude install libapache2-mod-wsgi
 - Enable mod_wsgi::
     a2enmod wsgi
 - Create a wsgi dispatch script, like the one below. Make sure you
   check that the paths correctly point to where you installed Kallithea
   and its Python Virtual Environment.
 - Enable the ``WSGIScriptAlias`` directive for the WSGI dispatch script,
   as in the following example. Once again, check the paths are
   correctly specified.
 Here is a sample excerpt from an Apache Virtual Host configuration file::
 Here is a sample excerpt from an Apache Virtual Host configuration file:
 .. code-block:: apache
     WSGIDaemonProcess kallithea \
         processes=1 threads=4 \
         python-path=/srv/kallithea/pyenv/lib/python2.7/site-packages
     WSGIScriptAlias / /srv/kallithea/dispatch.wsgi
     WSGIPassAuthorization On
 Or if using a dispatcher WSGI script with proper virtualenv activation::
 Or if using a dispatcher WSGI script with proper virtualenv activation:
 .. code-block:: apache
     WSGIDaemonProcess kallithea processes=1 threads=4
     WSGIScriptAlias / /srv/kallithea/dispatch.wsgi
     WSGIPassAuthorization On
 .. note::
    When running apache as root, please make sure it doesn't run Kallithea as
    root, for examply by adding: ``user=www-data group=www-data`` to the configuration.
 .. note::
    If running Kallithea in multiprocess mode,
    make sure you set ``instance_id = *`` in the configuration so each process
    gets it's own cache invalidation key.
 Example WSGI dispatch script::
 Example WSGI dispatch script:
 .. code-block:: python
     import os
     os.environ["HGENCODING"] = "UTF-8"
     os.environ['PYTHON_EGG_CACHE'] = '/srv/kallithea/.egg-cache'
     # sometimes it's needed to set the curent dir
     os.chdir('/srv/kallithea/')
     import site
     site.addsitedir("/srv/kallithea/pyenv/lib/python2.7/site-packages")
     from paste.deploy import loadapp
     from paste.script.util.logging_config import fileConfig
     fileConfig('/srv/kallithea/my.ini')
     application = loadapp('config:/srv/kallithea/my.ini')
 Or using proper virtualenv activation::
 Or using proper virtualenv activation:
 .. code-block:: python
     activate_this = '/srv/kallithea/venv/bin/activate_this.py'
     execfile(activate_this,dict(__file__=activate_this))
+    execfile(activate_this, dict(__file__=activate_this))
     import os
     os.environ['HOME'] = '/srv/kallithea'
     ini = '/srv/kallithea/kallithea.ini'
     from paste.script.util.logging_config import fileConfig
     fileConfig(ini)
     from paste.deploy import loadapp
     application = loadapp('config:' + ini)
 Other configuration files
 -------------------------
 Some example init.d scripts can be found in the ``init.d`` directory:
 https://kallithea-scm.org/repos/kallithea/files/tip/init.d/ .
 A number of `example init.d scripts`__ can be found in
 the ``init.d`` directory of the Kallithea source.
 .. __: https://kallithea-scm.org/repos/kallithea/files/tip/init.d/ .
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _Mercurial: http://mercurial.selenic.com/
 .. _Celery: http://celeryproject.org/
 .. _Celery documentation: http://docs.celeryproject.org/en/latest/getting-started/index.html
 .. _RabbitMQ: http://www.rabbitmq.com/
 .. _Redis: http://redis.io/
 .. _python-ldap: http://www.python-ldap.org/
 .. _mercurial-server: http://www.lshift.net/mercurial-server.html
 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories

docs/usage/general.rst

➞

Show inline comments

 .. _general:
 =======================
 General Kallithea usage
 =======================
-Repository deleting
+Repository deletion
 -------------------
 Currently when an admin or owner deletes a repository, Kallithea does
 not physically delete said repository from the filesystem, but instead
 renames it in a special way so that it is not possible to push, clone
 or access the repository.
-There is a special command for cleaning up such archived repos::
+There is a special command for cleaning up such archived repositories::
     paster cleanup-repos --older-than=30d my.ini
 This command scans for archived repositories that are older than
 days, displays them, and asks if you want to delete them (unless given
 the ``--dont-ask`` flag). If you host a large amount of repositories with
 forks that are constantly being deleted, it is recommended that you run this
 command via crontab.
 It is worth noting that even if someone is given administrative access to
 Kallithea and deletes a repository, you can easily restore such an action by
 renaming the repository directory, removing the ``rm__<date>`` prefix.
 File view: follow current branch
 --------------------------------
 In the file view, left and right arrows allow to jump to the previous and next
 revision. Depending on the way revisions were created in the repository, this
 could jump to a different branch.  When the checkbox ``Follow current branch``
 is checked, these arrows will only jump to revisions on the same branch as the
 currently visible revision.  So for example, if someone is viewing files in the
 ``beta`` branch and marks the `Follow current branch` checkbox, the < and >
 arrows will only show revisions on the ``beta`` branch.
@@ @@ -49,79 +49,81 @@ changelog. @@
 Branch filter
   By default, the changelog shows revisions from all branches in the
   repository. Use the branch filter to restrict to a given branch.
 Viewing a changeset
   A particular changeset can be opened by clicking on either the changeset
   hash or the commit message, or by ticking the checkbox and clicking the
   ``Show selected changeset`` button at the top.
 Viewing all changes between two changesets
   To get a list of all changesets between two selected changesets, along with
   the changes in each one of them, tick the checkboxes of the first and
   last changeset in the desired range and click the ``Show selected changesets``
   button at the top. You can only show the range between the first and last
   checkbox (no cherry-picking).
   From that page, you can proceed to viewing the overall delta between the
   selected changesets, by clicking the ``Compare revisions`` button.
 Creating a pull request
   You can create a new pull request for the changes of a particular changeset
   (and its ancestors) by selecting it and clicking the ``Open new pull request
   for selected changesets`` button.
 Permanent repository URLs
 -------------------------
 Due to the complicated nature of repository grouping, URLs of repositories
 can often change. For example, a repository originally accessible from::
-  http://server.com/repo_name
+  http://example.com/repo_name
 would get a new URL after moving it to test_group::
-  http://server.com/test_group/repo_name
+  http://example.com/test_group/repo_name
 Such moving of a repository to a group can be an issue for build systems and
 other scripts where the repository paths are hardcoded. To mitigate this,
 Kallithea provides permanent URLs using the repository ID prefixed with an
 underscore. In all Kallithea URLs, for example those for the changelog and the
 file view, a repository name can be replaced by this ``_ID`` string. Since IDs
 are always the same, moving the repository to a different group will not affect
 such URLs.
 In the example, the repository could also be accessible as::
-  http://server.com/_<ID>
+  http://example.com/_<ID>
 The ID of a given repository can be shown from the repository ``Summary`` page,
 by selecting the ``Show by ID`` button next to ``Clone URL``.
 Email notifications
 -------------------
-When the administrator correctly specified the email settings in the Kallithea
+With email settings properly configured in the Kallithea
 configuration file, Kallithea will send emails on user registration and when
 errors occur.
 Emails are also sent for comments on changesets. In this case, an email is sent
 to the committer of the changeset (if known to Kallithea), to all reviewers of
 the pull request (if applicable) and to all people mentioned in the comment
 using @mention notation.
 Trending source files
 ---------------------
 Trending source files are calculated based on a predefined dictionary of known
 types and extensions. If an extension is missing or you would like to scan
 custom files, it is possible to extend the ``LANGUAGES_EXTENSIONS_MAP``
 dictionary located in ``kallithea/config/conf.py`` with new types.
 Cloning remote repositories
 ---------------------------
 Kallithea has the ability to clone repositories from given remote locations.
 Currently it supports the following options:
@@ @@ -130,49 +132,50 @@ Currently it supports the following opti @@
 - git -> git clone
 .. note:: svn -> hg cloning requires the ``hgsubversion`` library to be
    installed.
 If you need to clone repositories that are protected via basic authentication,
 you can pass the credentials in the URL, e.g.
 ``http://user:passw@remote.server/repo``. Kallithea will then try to login and
 clone using the given credentials. Please note that the given credentials will
 be stored as plaintext inside the database. However, the authentication
 information will not be shown in the clone URL on the summary page.
 Specific features configurable in the Admin settings
 ----------------------------------------------------
 In general, the Admin settings should be self-explanatory and will not be
 described in more detail in this documentation. However, there are a few
 features that merit further explanation.
 Repository extra fields
 ~~~~~~~~~~~~~~~~~~~~~~~
 In the `Visual` tab, there is an option `Use repository extra
 fields`, which allows to set custom fields for each repository in the system.
 Each new field consists of 3 attributes: ``field key``, ``field label``,
 ``field description``.
 In the *Visual* tab, there is an option "Use repository extra
 fields", which allows to set custom fields for each repository in the system.
 Once enabled site-wide, the custom fields can be edited per-repository under
 *Options* | *Settings* | *Extra Fields*.
 Example usage of such fields would be to define company-specific information
 into repositories, e.g., defining a ``repo_manager`` key that would give info
 about a manager of each repository.  There's no limit for adding custom fields.
 Newly created fields are accessible via the API.
 Meta tagging
 ~~~~~~~~~~~~
 In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea
 to turn certain meta-tags, detected in repository and repository group
 descriptions, into colored tags. Currently recognised tags are::
 In the *Visual* tab, option "Stylify recognised meta tags" will cause Kallithea
 to turn certain text fragments in repository and repository group
 descriptions into colored tags. Currently recognised tags are::
     [featured]
     [stale]
     [dead]
     [lang => lang]
     [license => License]
     [requires => Repo]
     [recommends => Repo]
     [see => URI]

docs/usage/locking.rst

➞

Show inline comments

 .. _locking:
 ==================
 Repository locking
 ==================
-Kallithea has a ``repository locking`` feature, disabled by default. When
+Kallithea has a *repository locking* feature, disabled by default. When
 enabled, every initial clone and every pull gives users (with write permission)
 the exclusive right to do a push.
 When repository locking is enabled, repositories get a ``locked`` state that
 can be true or false.  The hg/git commands ``hg/git clone``, ``hg/git pull``,
 When repository locking is enabled, repositories get a ``locked`` flag.
 The hg/git commands ``hg/git clone``, ``hg/git pull``,
 and ``hg/git push`` influence this state:
-- A ``clone`` or ``pull`` action on the repository locks it (``locked=true``)
+- A ``clone`` or ``pull`` action locks the target repository
   if the user has write/admin permissions on this repository.
 - Kallithea will remember the user who locked the repository so only this
-  specific user can unlock the repo (``locked=false``) by performing a ``push``
   specific user can unlock the repo by performing a ``push``
   command.
 - Every other command on a locked repository from this user and every command
   from any other user will result in an HTTP return code 423 (Locked).
-  Additionally, the HTTP error includes the <user> that locked the repository
+  Additionally, the HTTP error will mention the user that locked the repository
   (e.g., “repository <repo> locked by user <user>”).
 Each repository can be manually unlocked by an administrator from the
 repository settings menu.

docs/usage/performance.rst

➞

Show inline comments

 .. _performance:
 ================================
 Optimizing Kallithea performance
 ================================
 When serving a large amount of big repositories, Kallithea can start
 performing slower than expected. Because of the demanding nature of handling large
 amounts of data from version control systems, here are some tips on how to get
 the best performance.
 * Kallithea will perform better on machines with faster disks (SSD/SAN). It's
   more important to have a faster disk than a faster CPU.
 * Kallithea is often I/O bound, and hence a fast disk (SSD/SAN) is
   usually more important than a fast CPU.
-* Slowness on initial page can be easily fixed by grouping repositories, and/or
+* Sluggish loading of the front page can easily be fixed by grouping repositories or by
   increasing cache size (see below). This includes using the lightweight dashboard
   option and ``vcs_full_cache`` setting in .ini file
+  option and ``vcs_full_cache`` setting in .ini file.
 Follow these few steps to improve performance of Kallithea system.
 . Increase cache
     Tweak beaker cache settings in the ini file. The actual effect of that
     is questionable.
-. Switch from sqlite to postgres or mysql
+. Switch from SQLite to PostgreSQL or MySQL
     sqlite is a good option when having a small load on the system. But due to
     locking issues with sqlite, it is not recommended to use it for larger
     deployments. Switching to mysql or postgres will result in an immediate
     SQLite is a good option when having a small load on the system. But due to
     locking issues with SQLite, it is not recommended to use it for larger
     deployments. Switching to MySQL or PostgreSQL will result in an immediate
     performance increase. A tool like SQLAlchemyGrate_ can be used for
     migrating to another database platform.
 . Scale Kallithea horizontally
     Scaling horizontally can give huge performance increases when dealing with
     large traffic (large amount of users, CI servers etc). Kallithea can be
     Scaling horizontally can give huge performance benefits when dealing with
     large amounts of traffic (many users, CI servers, etc.). Kallithea can be
     scaled horizontally on one (recommended) or multiple machines. In order
     to scale horizontally you need to do the following:
     - Each instance needs its own .ini file and unique ``instance_id`` set.
     - Each instance's ``data`` storage needs to be configured to be stored on a
       shared disk storage, preferably together with repositories. This ``data``
       dir contains template caches, sessions, whoosh index and is used for
       task locking (so it is safe across multiple instances). Set the
       ``cache_dir``, ``index_dir``, ``beaker.cache.data_dir``, ``beaker.cache.lock_dir``
       variables in each .ini file to a shared location across Kallithea instances
     - If celery is used each instance should run a separate Celery instance, but
       the message broker should be common to all of them (e.g.,  one
       shared RabbitMQ server)
     - Load balance using round robin or IP hash, recommended is writing LB rules
       that will separate regular user traffic from automated processes like CI
       servers or build bots.
 .. _SQLAlchemyGrate: https://github.com/shazow/sqlalchemygrate

docs/usage/statistics.rst

➞

Show inline comments

 .. _statistics:
 =====================
 Repository statistics
 =====================
-Kallithea has a ``repository statistics`` feature, disabled by default. When
+Kallithea has a *repository statistics* feature, disabled by default. When
 enabled, the amount of commits per committer is visualized in a timeline. This
 feature can be enabled using the ``Enable statistics`` checkbox on the
 repository ``Settings`` page.
 The statistics system makes heavy demands on the server resources, so
 in order to keep a balance between usability and performance, statistics are
 cached inside the database and gathered incrementally.
 When Celery is disabled:
   On each first visit to the summary page a set of 250 commits are parsed and
   added to the statistics cache. This incremental gathering also happens on each
   visit to the statistics page, until all commits are fetched.
   Statistics are kept cached until additional commits are added to the
   repository. In such a case Kallithea will only fetch the new commits when
   updating its statistics cache.
 When Celery is enabled:
   On the first visit to the summary page, Kallithea will create tasks that will
   execute on Celery workers. These tasks will gather all of the statistics until
   all commits are parsed. Each task parses 250 commits, then launches a new
   task.

docs/usage/troubleshooting.rst

➞

Show inline comments

 .. _troubleshooting:
 ===============
 Troubleshooting
 ===============
 :Q: **Missing static files?**
 :A: Make sure either to set the ``static_files = true`` in the .ini file or
    double check the root path for your http setup. It should point to
    for example:
    ``/home/my-virtual-python/lib/python2.7/site-packages/kallithea/public``
+|
 :Q: **Can't install celery/rabbitmq?**
 :A: Don't worry. Kallithea works without them, too. No extra setup is required.
     Try out the great Celery docs for further help.
+|
 :Q: **Long lasting push timeouts?**
 :A: Make sure you set a longer timeout in your proxy/fcgi settings. Timeouts
     are caused by the http server and not Kallithea.
+|

0 comments (0 inline, 0 general)