README.rst

Gitolite
########

.. image:: https://travis-ci.org/adarnimrod/gitolite.svg?branch=master
    :target: https://travis-ci.org/adarnimrod/gitolite

Provision Gitolite and a readonly cgit web interface served by Apache.

Requirements
------------

See :code:`meta/main.yml` and assertions at the top of :code:`tasks/main.yml`.

Role Variables
--------------

See :code:`defaults/main.yml`.

Dependencies
------------

See :code:`meta/main.yml`.

Example Playbook
----------------

See :code:`tests/playbook.yml`.

Testing
-------

Testing requires Python 2.7 and either Docker or Vagrant and Virtualbox.
Install the Python dependencies, dependent roles and roles required for
testing:

.. code:: shell

    pip install -r tests/requirements.txt
    ansible-galaxy install git+file://$(pwd),$(git rev-parse --abbrev-ref HEAD) -p .molecule/roles
    molecule dependency

To run the full test suite:

.. code:: shell

    pre-commit run --all-files
    molecule test --platform all

License
-------

This software is licensed under the MIT license (see the :code:`LICENSE.txt`
file).

Author Information
------------------

Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located
at: https://git.shore.co.il/explore/.

TODO
----

- Test repository config with cgit.
- Investigate hook (like deploying, etc.)
- Test integration with ssh_ca.
- Include dependencies in `meta/main.yml` and test.
- Log to syslog.
- Metrics?
- Flush handlers and wait for service to come up.
- Add mail alias.
- Remove dependency on the common role, use specific roles.
- Tests.