PHPackages                             dontdrinkandroot/gitki-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. dontdrinkandroot/gitki-bundle

ActiveSymfony-bundle[Parsing & Serialization](/categories/parsing)

dontdrinkandroot/gitki-bundle
=============================

Symfony Bundle that allows you to easily integrate a git based wiki into your project

v0.2.0(8y ago)95472[13 issues](https://github.com/dontdrinkandroot/gitki-bundle.php/issues)[1 PRs](https://github.com/dontdrinkandroot/gitki-bundle.php/pulls)1Apache-2.0PHPPHP >=7.1

Since May 3Pushed 1y ago5 watchersCompare

[ Source](https://github.com/dontdrinkandroot/gitki-bundle.php)[ Packagist](https://packagist.org/packages/dontdrinkandroot/gitki-bundle)[ RSS](/packages/dontdrinkandroot-gitki-bundle/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (21)Versions (10)Used By (1)

gitki-bundle
============

[](#gitki-bundle)

[![Latest Stable Version](https://camo.githubusercontent.com/670b2836798b1a377dcdd0bc965fd182e4565fdb8234383b213a6a2e03072c99/687474703a2f2f706f7365722e707567782e6f72672f646f6e746472696e6b616e64726f6f742f6769746b692d62756e646c652f76)](https://packagist.org/packages/dontdrinkandroot/gitki-bundle)[![License](https://camo.githubusercontent.com/100ceace53fa15de955e7bd48572e23616075e0e17d937479fc423873bb36833/687474703a2f2f706f7365722e707567782e6f72672f646f6e746472696e6b616e64726f6f742f6769746b692d62756e646c652f6c6963656e7365)](https://packagist.org/packages/dontdrinkandroot/gitki-bundle)[![Continuous Integration](https://github.com/dontdrinkandroot/gitki-bundle.php/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/dontdrinkandroot/gitki-bundle.php/actions/workflows/continuous-integration.yml/badge.svg)[![Coverage](https://camo.githubusercontent.com/974c0bde51bb31938cb7879142d8475a6e516f32324448191e5669daadce56df/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d646f6e746472696e6b616e64726f6f745f6769746b692d62756e646c652e706870266d65747269633d636f766572616765)](https://sonarcloud.io/dashboard?id=dontdrinkandroot_gitki-bundle.php)[![Maintainability Rating](https://camo.githubusercontent.com/25339be3f8c7aab52f3e038d3ac2905924e5ddb5d572b5e26f2f1244e2c02f80/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d646f6e746472696e6b616e64726f6f745f6769746b692d62756e646c652e706870266d65747269633d7371616c655f726174696e67)](https://sonarcloud.io/dashboard?id=dontdrinkandroot_gitki-bundle.php)[![Reliability Rating](https://camo.githubusercontent.com/e862ed2dadeb3dc608b66b91fe8d459b43e7c2c4e759f70041442571c573de68/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d646f6e746472696e6b616e64726f6f745f6769746b692d62756e646c652e706870266d65747269633d72656c696162696c6974795f726174696e67)](https://sonarcloud.io/dashboard?id=dontdrinkandroot_gitki-bundle.php)[![Security Rating](https://camo.githubusercontent.com/944bcfa3797923a56885a2710eb4c9caaefbe8ea1ffd9854d06264ef91723160/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d646f6e746472696e6b616e64726f6f745f6769746b692d62756e646c652e706870266d65747269633d73656375726974795f726174696e67)](https://sonarcloud.io/dashboard?id=dontdrinkandroot_gitki-bundle.php)

About
-----

[](#about)

Symfony Bundle that allows you to easily integrate a git based wiki into you project.

This project is currently in alpha state. It is working but changes happen frequently.

### Features

[](#features)

- Git based
- Fully integrated markdown support (commonmark)
- Optional elasticsearch integration
- Minimal configuration
- Easy to extend
- Easy to integrate

Installation
------------

[](#installation)

Install via composer:

```
composer require dontdrinkandroot/gitki-bundle

```

Enable the bundle by adding the following line in the `app/AppKernel.php` file of your project:

```
// app/AppKernel.php
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Dontdrinkandroot\GitkiBundle\DdrGitkiBundle(),
        );

        // ...
    }
}
```

To use this bundle in your project the User class handed to the bundle *must* implement the `Dontdrinkandroot\GitkiBundle\Model\GitUserInterface`. Fortunately this is compatible with the FOSUserBundle.

Configuration
-------------

[](#configuration)

Configure the bundle in the `app/config/config.yml`. At least the repository path is required which must point to a git repository which is initialized and readable/writeable by the webserver.

```
# Default configuration for extension with alias: "ddr_gitki"
ddr_gitki:

    # The path to the git repository containing the wiki files. Must end with slash.
    repository_path:      ~ # Required

    # When enabled breadcrumbs are shown for easy navigation
    show_breadcrumbs:     true

    # When enabled the files and folders of the containing directory are shown while viewing a file
    show_directory_contents: true

    # Markdown specific configuration
    markdown:

        # When disabled all html content is escaped
        allow_html:           false
        toc:

            # Show the table of contents
            enabled:              true

            # Max depth of the table of contents
            max_level:            3

    # Configure elasticsearch integration
    elasticsearch:
        index_name:           ~ # Required
        host:                 localhost
        port:                 9200

    # Maps user roles to internal roles
    roles:

        # Is allowed to view content
        watcher:              IS_AUTHENTICATED_ANONYMOUSLY

        # Is allowed to edit content
        committer:            ROLE_USER
        admin:                ROLE_ADMIN

    # The file names that are used as a directory index. Searched in the order defined.
    index_files:

        # Defaults:
        - index.md
        - README.md
        - index.txt
        - README.txt

```

Add the routing to the `app/config/routing.yml`:

```
ddr_gitki_base:
resource: "@DdrGitkiBundle/Resources/config/routing.yml"
prefix: /wiki

```

Development
-----------

[](#development)

Run elasticsearch in docker locally:

`docker run -p 127.0.0.1:9200:9200 -p 127.0.0.1:9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:7.16.3`

[Source](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html)

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance8

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 99.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~545 days

Recently: every ~655 days

Total

6

Last Release

1199d ago

PHP version history (5 changes)v0.1.0PHP >=5.4

v0.1.2PHP >=5.5

v0.1.3PHP >=5.6

v0.2.0PHP >=7.1

v0.3.x-devPHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/c40ca062403944d164d637c836746f4481f96c914475940417bf4ca3059ee370?d=identicon)[philipsorst](/maintainers/philipsorst)

---

Top Contributors

[![philipsorst](https://avatars.githubusercontent.com/u/2827467?v=4)](https://github.com/philipsorst "philipsorst (251 commits)")[![hason](https://avatars.githubusercontent.com/u/288535?v=4)](https://github.com/hason "hason (1 commits)")

---

Tags

bundlegitmarkdownsymfonywikisymfonybundlemarkdowngitwiki

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/dontdrinkandroot-gitki-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/dontdrinkandroot-gitki-bundle/health.svg)](https://phpackages.com/packages/dontdrinkandroot-gitki-bundle)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[easycorp/easyadmin-bundle

Admin generator for Symfony applications

4.3k16.7M310](/packages/easycorp-easyadmin-bundle)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[contao/core-bundle

Contao Open Source CMS

1231.6M2.4k](/packages/contao-core-bundle)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)