Jump to content

Extension:Git2Pages

From mediawiki.org
Warning Warning: All versions of Git2Pages before 1.1.1, are vulnerable to directory traversal and remote code execution attacks, which could lead into compromisation of your wiki/server. We strongly recommend you to update your copy of Git2Pages to 1.1.1. The tarballs of Special:ExtensionDistributor will be updated as soon as possible, the REL1_23, REL1_24, REL1_25 and master branches of the git repo of Git2Pages already include the security fix.
MediaWiki extensions manual
Git2Pages
Release status: unmaintained
Implementation Parser extension , Tag , Database
Description Allow wiki pages to include code from a git repository.
Author(s) Teresa Cho (original author)
Dereckson (maintenance)
Contributions by others
Latest version 1.1.1 (2015-10-08)
MediaWiki >= 1.31.0
PHP 5.3+
Database changes No
License GNU General Public License 2.0 or later
Download

  • $wgGit2PagesDataDir
Quarterly downloads 1 (Ranked 128th)
Translate the Git2Pages extension if it is available at translatewiki.net
Issues Open tasks ¡ Report a bug

The Git2Pages extension implements a parser tag so you can transclude snippets of files in a git repository into wiki pages. To do so it executes git commands to clone a repository locally and then reads files from disk.

Usage

[edit]

{{#snippet:repository=MYREPO|filename=MYFILE|branch=MYBRANCH |startline=STARTLINE|endline=ENDLINE}}

The parameters are:

  • repository - The URL of the git repository. REQUIRED
  • filename - The filename whose data is going to be displayed. REQUIRED
  • branch - The branch to look for the file. OPTIONAL (Default = master)
  • startline - The start of where the snippet will be pulled. OPTIONAL (Default = Start of file)
  • endline - The end of where the snippet will be pulled. OPTIONAL (Default = End of file)

Requirements

[edit]

This extension uses wfShellExec() to run shell commands that probably require the bash shell.

Installation

[edit]
  • Download and move the extracted Git2Pages folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Git2Pages
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'Git2Pages' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

See also

[edit]