kallithea Changeset - 57caeb60c52b

Changeset - 57caeb60c52b

Parent rev.

Child rev.

[Not reviewed]

stable

0 2 1

Robert Rauch - 11 years ago 2015-09-03 13:10:17
mail@robertrauch.de

docs: add documentation for setup with puppet

Incorporates feedback from Branko Majic and Søren Løvborg.

3 files changed with 184 insertions and 0 deletions:

README.rst

docs/index.rst

docs/installation_puppet.rst

175

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.
 Please visit https://docs.kallithea-scm.org/en/latest/installation.html for
 more details.
 There is also an experimental `Puppet module`_ for installing and setting up
 Kallithea. Currently, only basic functionality is provided, but it is still
 enough to get up and running quickly, especially for people without Python
 background. See
 https://docs.kallithea-scm.org/en/latest/installation_puppet.html for further
 information.
 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
   each repository, additional explicit forking, repositories group and
   repository creation permissions.
 - User groups for easier permission management.
 - Repository groups let you group repos and manage them easier. They come with
   permission delegation features, so you can delegate groups management.
 - Users can fork other users repos, and compare them at any time.
 - Built-in versioned paste functionality (Gist) for sharing code snippets.
 - Integrates easily with other systems, with custom created mappers you can
   connect it to almost any issue tracker, and with a JSON-RPC API you can make
   much more.
 - Built-in commit API lets you add, edit and commit files right from Kallithea
   web interface using simple editor or upload binary files using simple form.
 - Powerful pull request driven review system with inline commenting, changeset
   statuses, and notification system.
 - Importing and syncing repositories from remote locations for Git_, Mercurial_
   and Subversion.
 - Mako templates let you customize the look and feel of the application.
 - Beautiful diffs, annotations and source code browsing all colored by
   pygments. Raw diffs are made in Git-diff format for both VCS systems,
   including Git_ binary-patches.
 - Mercurial_ and Git_ DAG graphs and Flot-powered graphs with zooming and
   statistics to track activity for repositories.
 - Admin interface with user/permission management. Admin activity journal, logs
   pulls, pushes, forks, registrations and other actions made by all users.
 - Server side forks. It is possible to fork a project and modify it freely
   without breaking the main repository.
 - reST and Markdown README support for repositories.
 - Full text search powered by Whoosh on the source files, commit messages, and
   file names. Built-in indexing daemons, with optional incremental index build
   (no external search servers required all in one application).
 - Setup project descriptions/tags and info inside built in DB for easy,
   non-filesystem operations.
 - Intelligent cache with invalidation after push or project change, provides
   high performance and always up to date data.
 - RSS/Atom feeds, Gravatar support, downloadable sources as zip/tar/gz.
 - Optional async tasks for speed and performance using Celery_.
 - Backup scripts can do backup of whole app and send it over scp to desired
   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.
 Get in touch with the rest of the community:
 - 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>`_.
@@ @@ -145,96 +152,97 @@ 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::
    make html
 .. note:: You need to have Sphinx_ installed to build the
           documentation. If you don't have Sphinx_ installed you can
           install it via the command: ``pip install sphinx`` .
 Converting from RhodeCode
 -------------------------
 Currently, you have two options for working with an existing RhodeCode
 database:
 - keep the database unconverted (intended for testing and evaluation)
 - convert the database in a one-time step
 Maintaining interoperability
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Interoperability with RhodeCode 2.2.X installations is provided so you don't
 have to immediately commit to switching to Kallithea. This option will most
 likely go away once the two projects have diverged significantly.
 To run Kallithea on a RhodeCode database, run::
    echo "BRAND = 'rhodecode'" > kallithea/brand.py
 This location will depend on where you installed Kallithea. If you installed
 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.
 Git hooks
 ~~~~~~~~~
 After switching to Kallithea, it will be necessary to update the Git_ hooks in
 your repositories. If not, the Git_ hooks from RhodeCode will still be called,
 which will cause ``git push`` to fail every time.
 If you do not have any custom Git_ hooks deployed, perform the following steps
 (this may take some time depending on the number and size of repositories you
 have):
 . Log-in as an administrator.
 . Open page *Admin > Settings > Remap and Rescan*.
 . Turn on the option **Install Git Hooks**.
 . Turn on the option **Overwrite existing Git hooks**.
 . Click on the button **Rescan Repositories**.
 If you do have custom hooks, you will need to merge those changes manually. In
 order to get sample hooks from Kallithea, the easiest way is to create a new Git_
 repository, and have a look at the hooks deployed there.
 .. _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/
 .. _Puppet module: https://forge.puppetlabs.com/rauch/kallithea

docs/index.rst

➞

Show inline comments

 .. _index:
 #######################
 Kallithea Documentation
 #######################
 **Readme**
 .. toctree::
    :maxdepth: 1
    readme
 **Installation**
 .. toctree::
    :maxdepth: 1
    overview
    installation
    installation_win
    installation_win_old
    installation_iis
    setup
    installation_puppet
 **Usage**
 .. toctree::
    :maxdepth: 1
    usage/general
    usage/vcs_support
    usage/locking
    usage/statistics
 **Administrator's guide**
 .. toctree::
    :maxdepth: 1
    usage/email
    usage/performance
    usage/backup
    usage/debugging
    usage/troubleshooting
 **Development**
 .. toctree::
    :maxdepth: 1
    contributing
    changelog
 **API**
 .. toctree::
    :maxdepth: 1
    api/api
    api/models
 Other topics
 ------------
 * :ref:`genindex`
 * :ref:`search`
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _django: http://www.djangoproject.com/
 .. _mercurial: http://mercurial.selenic.com/
 .. _bitbucket: http://bitbucket.org/
 .. _subversion: http://subversion.tigris.org/
 .. _git: http://git-scm.com/
 .. _celery: http://celeryproject.org/
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _vcs: http://pypi.python.org/pypi/vcs

docs/installation_puppet.rst

➞

Show inline comments

@@ new file 100644 @@
 .. _installation_puppet:
 ===================================
 Installation and setup using Puppet
 ===================================
 The whole installation and setup process of Kallithea can be simplified by
 using Puppet and the `rauch/kallithea
 <https://forge.puppetlabs.com/rauch/kallithea>`_ Puppet module. This is
 especially useful for getting started quickly, without having to deal with all
 the Python specialities.
 .. note:: The following instructions assume you are not familiar with Puppet at
           all. If this is not the case, you should probably skip directly to the
           `Kallithea Puppet module documentation
           <https://forge.puppetlabs.com/rauch/kallithea#puppet-kallithea>`_.
 Installing Puppet
 -----------------
 This installation variant requires a Unix/Linux type server with Puppet 3.0+
 installed. Many major distributions have Puppet in their standard repositories.
 Thus, you will probably be ready to go by running, e.g. ``apt-get install
 puppet`` or ``yum install puppet``, depending on your distro's favoured package
 manager. Afterwards, check the Puppet version by running ``puppet --version``
 and ensure you have at least 3.0.
 If your distribution does not provide Puppet packages or you need a
 newer version, please see the `Puppet Reference Manual
 <https://docs.puppetlabs.com/puppet/4.2/reference/install_linux.html>`_ for
 instructions on how to install Puppet on your target platform.
 Installing the Puppet module
 ----------------------------
 To install the latest version of the Kallithea Puppet module from the Puppet
 Forge, run the following as ``root``:
 .. code-block:: bash
     puppet module install rauch/kallithea
 This will install both the Kallithea Puppet module and its dependency modules.
 .. warning::  Be aware that Puppet can do all kinds of things to your systems.
               Third-party modules (like the ``kallithea`` module) may run
               arbitrary commands on your system (most of the time as the
               ``root`` user), so do not apply them on production machines if
               you don't know what you are doing. Instead, use a test system
               (e.g. a virtual machine) for evaluation purposes.
 Applying the module
 -------------------
 To trigger the actual installation process, we have to *apply* the
 ``kallithea`` Puppet class, which is provided by the module we have just
 installed, to our system. For this, create a file named e.g. ``kallithea.pp``,
 a *Puppet manifest*, with the following content:
 .. _simple_manifest:
 .. code-block:: puppet
     class { 'kallithea':
       seed_db    => true,
       manage_git => true,
+    }
 To apply the manifest, simply run the following (preferably as root):
 .. code-block:: bash
     puppet apply kallithea.pp
 This will basically run through the usual Kallithea :ref:`installation` and
 :ref:`setup` steps, as documented. Consult the module documentation for details
 on `what the module affects
 <https://forge.puppetlabs.com/rauch/kallithea#what-kallithea-affects>`_. You
 can also do a *dry run* by adding the ``--noop`` option to the command.
 Using parameters for customizing the setup process
 --------------------------------------------------
 The ``kallithea`` Puppet class provides a number of `parameters
 <https://forge.puppetlabs.com/rauch/kallithea#class-kallithea>`_ for
 customizing the setup process. You have seen the usage of the ``seed_db``
 parameter in the :ref:`example above <simple_manifest>`, but there are more.
 For example, you can specify the installation directory, the name of the user
 under which Kallithea gets installed, the initial admin password, etc.
 Notably, you can provide arbitrary modifications to Kallitheas configuration
 file by means of the ``config_hash`` parameter.
 Parameters, which have not been set explicitly, will be set to default values,
 which are defined inside the ``kallithea`` Puppet module. For example, if you
 just stick to the defaults as in the :ref:`example above <simple_manifest>`,
 you will end up with a Kallithea instance, which
 - is installed in ``/srv/kallithea``, owned by the user ``kallithea``
 - uses the Kallithea default configuration
 - uses the admin user ``admin`` with password ``adminpw``
 - is started automatically and enabled on boot
 As of Kallithea 0.3.0, this in particular means that Kallithea will use an
 SQLite database and listen on ``http://localhost:5000``.
 See also the `full parameters list
 <https://forge.puppetlabs.com/rauch/kallithea#class-kallithea>`_ for more
 information.
 Making your Kallithea instance publicly available
 -------------------------------------------------
 If you followed the instructions above, the Kallithea instance will be
 listening on ``http://localhost:5000`` and therefore not publicly available.
 There are several ways to change this.
 The direct way
 ^^^^^^^^^^^^^^
 The simplest setup is to instruct Kallithea to listen on another IP address
 and/or port by using the ``config_hash`` parameter of the Kallithea Puppet
 class. For example, assume we want to listen on all interfaces on port 80:
 .. code-block:: puppet
     class { 'kallithea':
       seed_db => true,
       config_hash => {
         "server:main" => {
           'host' => '0.0.0.0',
           'port' => '80',
+        }
+      }
+    }
 Using Apache as reverse proxy
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 In a more advanced setup, you might instead want use a full-blown web server
 like Apache HTTP Server as the public web server, configured such that requests
 are internally forwarded to the local Kallithea instance (a so called *reverse
 proxy setup*). This can be easily done with Puppet as well:
 First, install the `puppetlabs/apache
 <https://forge.puppetlabs.com/puppetlabs/apache>`_ Puppet module as above by running the following as root:
 .. code-block:: bash
     puppet module install puppetlabs/apache
 Then, append the following to your manifest:
 .. code-block:: puppet
     include apache
     apache::vhost { 'kallithea.example.com':
       docroot             => '/var/www/html',
       manage_docroot      => false,
       port                => 80,
       proxy_preserve_host => true,
       proxy_pass          => [
+        {
           path => '/',
           url  => 'http://localhost:5000/',
         },
       ],
+    }
 Applying the resulting manifest will install the Apache web server and setup a
 virtual host acting as a reverse proxy for your local Kallithea instance.

0 comments (0 inline, 0 general)