{"id":22083023,"url":"https://github.com/dontdrinkandroot/gitki-bundle.php","last_synced_at":"2025-07-24T16:30:54.614Z","repository":{"id":28736079,"uuid":"32257433","full_name":"dontdrinkandroot/gitki-bundle.php","owner":"dontdrinkandroot","description":"Symfony Bundle that allows you to easily integrate a git based wiki into your project.","archived":false,"fork":false,"pushed_at":"2024-09-03T22:00:54.000Z","size":704,"stargazers_count":9,"open_issues_count":18,"forks_count":2,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-11-18T09:11:36.047Z","etag":null,"topics":["bundle","git","markdown","symfony","wiki"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dontdrinkandroot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-03-15T11:39:34.000Z","updated_at":"2024-05-13T13:58:55.000Z","dependencies_parsed_at":"2024-05-13T15:03:47.079Z","dependency_job_id":"af4ac4bf-8f9e-4055-b705-61ef3ab74ce2","html_url":"https://github.com/dontdrinkandroot/gitki-bundle.php","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dontdrinkandroot%2Fgitki-bundle.php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dontdrinkandroot%2Fgitki-bundle.php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dontdrinkandroot%2Fgitki-bundle.php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dontdrinkandroot%2Fgitki-bundle.php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dontdrinkandroot","download_url":"https://codeload.github.com/dontdrinkandroot/gitki-bundle.php/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227456610,"owners_count":17777942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bundle","git","markdown","symfony","wiki"],"created_at":"2024-12-01T00:09:22.235Z","updated_at":"2024-12-01T00:09:25.993Z","avatar_url":"https://github.com/dontdrinkandroot.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"gitki-bundle\n============\n\n[![Latest Stable Version](http://poser.pugx.org/dontdrinkandroot/gitki-bundle/v)](https://packagist.org/packages/dontdrinkandroot/gitki-bundle)\n[![License](http://poser.pugx.org/dontdrinkandroot/gitki-bundle/license)](https://packagist.org/packages/dontdrinkandroot/gitki-bundle)\n![Continuous Integration](https://github.com/dontdrinkandroot/gitki-bundle.php/actions/workflows/continuous-integration.yml/badge.svg)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=dontdrinkandroot_gitki-bundle.php\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=dontdrinkandroot_gitki-bundle.php)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=dontdrinkandroot_gitki-bundle.php\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=dontdrinkandroot_gitki-bundle.php)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=dontdrinkandroot_gitki-bundle.php\u0026metric=reliability_rating)](https://sonarcloud.io/dashboard?id=dontdrinkandroot_gitki-bundle.php)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=dontdrinkandroot_gitki-bundle.php\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=dontdrinkandroot_gitki-bundle.php)\n\nAbout\n-----\n\nSymfony Bundle that allows you to easily integrate a git based wiki into you project.\n\nThis project is currently in alpha state. It is working but changes happen frequently.\n\n### Features\n\n* Git based\n* Fully integrated markdown support (commonmark)\n* Optional elasticsearch integration\n* Minimal configuration\n* Easy to extend\n* Easy to integrate\n\nInstallation\n------------\n\nInstall via composer:\n\n```\ncomposer require dontdrinkandroot/gitki-bundle\n```\n\nEnable the bundle by adding the following line in the ```app/AppKernel.php``` file of your project:\n\n```php\n// app/AppKernel.php\nclass AppKernel extends Kernel\n{\n    public function registerBundles()\n    {\n        $bundles = array(\n            // ...\n            new Dontdrinkandroot\\GitkiBundle\\DdrGitkiBundle(),\n        );\n\n        // ...\n    }\n}\n```\n\nTo use this bundle in your project the User class handed to the bundle  *must* implement the\n```Dontdrinkandroot\\GitkiBundle\\Model\\GitUserInterface```. Fortunately this is compatible with the FOSUserBundle.\n\nConfiguration\n-------------\n\nConfigure the bundle in the ```app/config/config.yml```. At least the repository path is required which must point to a\ngit repository which is initialized and readable/writeable by the webserver.\n\n```\n# Default configuration for extension with alias: \"ddr_gitki\"\nddr_gitki:\n\n    # The path to the git repository containing the wiki files. Must end with slash.\n    repository_path:      ~ # Required\n\n    # When enabled breadcrumbs are shown for easy navigation\n    show_breadcrumbs:     true\n\n    # When enabled the files and folders of the containing directory are shown while viewing a file\n    show_directory_contents: true\n\n    # Markdown specific configuration\n    markdown:\n\n        # When disabled all html content is escaped\n        allow_html:           false\n        toc:\n\n            # Show the table of contents\n            enabled:              true\n\n            # Max depth of the table of contents\n            max_level:            3\n\n    # Configure elasticsearch integration\n    elasticsearch:\n        index_name:           ~ # Required\n        host:                 localhost\n        port:                 9200\n\n    # Maps user roles to internal roles\n    roles:\n\n        # Is allowed to view content\n        watcher:              IS_AUTHENTICATED_ANONYMOUSLY\n\n        # Is allowed to edit content\n        committer:            ROLE_USER\n        admin:                ROLE_ADMIN\n\n    # The file names that are used as a directory index. Searched in the order defined.\n    index_files:\n\n        # Defaults:\n        - index.md\n        - README.md\n        - index.txt\n        - README.txt\n```\n\nAdd the routing to the ```app/config/routing.yml```:\n\n```\nddr_gitki_base:\nresource: \"@DdrGitkiBundle/Resources/config/routing.yml\"\nprefix: /wiki\n```\n\nDevelopment\n-----------\n\nRun elasticsearch in docker locally:\n\n``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``\n\n[Source](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdontdrinkandroot%2Fgitki-bundle.php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdontdrinkandroot%2Fgitki-bundle.php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdontdrinkandroot%2Fgitki-bundle.php/lists"}