MediaWiki-Vagrant/Roles

In general the code for additional services such as browsertests, parsoid, and redis is checked out to /srv in the vagrant machine. Like the code in /mediawiki, it does not get updated automatically. Use git commands when you want to update it; unlike /mediawiki this directory is not available on the host machine.

To list available roles, run. will provide a brief description of a role.

List of roles

 * accountinfo: AccountInfo allows users to look at private information that is stored about them. It also includes the CheckUser extension, which AccountInfo integrates with.


 * analytics: Includes all analytics-related roles: hadoop and hive.


 * antispam: Installs and sets up AntiSpoof, AbuseFilter, and the SpamBlacklist extensions


 * apisandbox: This role simply sets up ApiSandbox


 * betafeatures: Configures BetaFeatures


 * browsertests: Configures this machine to run the Wikimedia Foundation's set of Selenium browser tests for MediaWiki instances.


 * chromium:


 * cirrussearch: CirrusSearch implements searching for MediaWiki using Elasticsearch.


 * cite: Provisions Cite, an extension which adds support for citations and references


 * cldr: CLDR provides functions to localize the names of languages, countries, and currencies based on their language code, using data extracted from the Common Locale Data Repository (CLDR), a project of the Unicode Consortium to provide locale data in the XML format for use in computer applications.


 * codeeditor: CodeEditor embeds the ACE code editor in the WikiEditor edit interface when source code content.


 * commonsmetadata: This role provisions CommonsMetadata, which adds image metadata extracted from the description page to the imageinfo API.


 * echo: Configures Echo, a MediaWiki notification framework.


 * education: Configures the Education Program Program extension & its dependencies.


 * eventlogging: This role sets up EventLogging for MediaWiki such that events are validated against production schemas but logged locally.


 * flow: Configures Flow, a MediaWiki discussion system.


 * fundraising: This role configures MediaWiki to use the '/1.22' branch and sets up the ContributionTracking, FundraisingEmailUnsubscribe, and DonationInterface extensions.


 * gadgets: Provisions Gadgets, which provides a way for users to pick JavaScript or CSS based "gadgets" that other wiki users provide.


 * generic: Configures common tools and shell enhancements.


 * geodata: GeoData is an extension that allows storing coordinates in articles and searching for them.


 * geshi: Configures SyntaxHighlight_GeSHi, an extension for syntax-highlighting


 * gettingstarted: Configures GettingStarted and its dependencies: EventLogging and GuidedTour. GettingStarted adds a special page which presents introductory content and tasks to newly-registered editors.


 * guidedtour: Configures Guided Tour, a MediaWiki extension which provides a framework for creating "guided tours", or interactive tutorials for MediaWiki features.


 * gwtoolset: Provisions the GWToolset extension, which does mass media file and metadata uploading based on an XML description. The provision includes its dependant extensions: and imports required Commons Mediawiki, Module and Template pages.


 * hadoop: Installs and runs all hadoop services.


 * hhvm : This role will configure your MediaWiki instance to run under HHVM. (Obsolete in current versions. HHVM is now the default; use the 'zend' role to run under standard Zend PHP.)


 * hive: Installs and runs hive client, hive metastore and hive server.


 * jsduck: This role provisions JSDuck, a Javascript documentation tool commonly used in MediaWiki code.


 * jsonconfig
 * This role provisions JsonConfig extension, allowing extensions to store JSON blobs in MediaWiki pages.


 * massmessage: This role provisions MassMessage, which allows users to easily send a message to a list of pages via the job queue, and a set of extensions which integrate with it: LiquidThreads, Echo, and MLEB.


 * math: This role enables the Extension:Math and installs the necessary dependencies. Since the PNG rendering mode requires to download huge LaTeX packages, make sure to have a fast internet connection and enough battery life time before enabling the role.


 * mathoid: Installs a local instance of the Mathoid redering server.


 * mathsearch: Installs the Extension:MathSearch.


 * mediawiki: Provisions a MediaWiki instance powered by PHP, MySQL, and redis.


 * mleb: The MediaWiki language extension bundle (MLEB) provides an easy way to bring ultimate language support to your MediaWiki. This role will install latest Universal Language Selector(ULS), Translate, Localisation Update, Clean Changes, Babel and CLDR MediaWiki extensions. What's more, Interwiki will be installed and configured so that MediaWiki can show the cross wiki link on the left sidebar.


 * mobilefrontend: Configures MobileFrontend, the MediaWiki extension which powers Wikimedia mobile sites.


 * multimedia: This class configures MediaWiki for development. It is meant to contain general configuration of shared use to other extensions that are commonly used by the multimedia team in development and testing.


 * multimediaviewer: This role provisions MultimediaViewer, which shows images and their metadata in a lightbox when the user clicks on the thumbnails.


 * mysql: Provisions a MySQL server


 * navigationtiming: Configures NavigationTiming, a MediaWiki extension that logs client-side page load latency measurements via the EventLogging API.


 * oauth: This role sets up OAuth for MediaWiki. Other OAuth enabled applications can then edit this instance of MediaWiki on its users' behalf.


 * pageimages: Configures PageImages, a MediaWiki extension which provides an API for getting the first meaningful image on a page


 * pagetriage: Configures Extension:PageTriage, the extension that powers the New Page Patrol workflow


 * parserfunctions: ParserFunctions enhances the wikitext parser with helpful functions, mostly related to logic and string-handling.


 * parsoid: Configures Parsoid, a wikitext parsing service


 * pdfhandler:


 * phptags: Configures Extension:PhpTags, an extension that implements the concept of Magic expressions with PHP language syntax in MediaWiki.


 * popups: Provisions Extension:Popups, which shows a popup when people hover over article links.


 * proofreadpage: Configures ProofreadPage, an extension to allow the proofreading of a text in comparison with scanned images.


 * scribunto: Configures Scribunto, an extension for embedding scripting languages in MediaWiki.


 * textextracts: Configures TextExtracts, a MediaWiki extension which provides an API for getting text extracts of articles


 * timedmediahandler: This role provisions TimedMediaHandler, which displays audio and video files and their captions.


 * uploadwizard: Configures a MediaWiki instance with UploadWizard, a JavaScript-driven wizard interface for uploading multiple files.


 * visualeditor: Provisions VisualEditor, backed by a local Parsoid instance.


 * wikidiff2: Installs Wikidiff2 package that speeds up diff generation in MediaWiki and configures MW to use it


 * wikieditor: Configures WikiEditor, an extension which enable an extendable editing toolbar and interface


 * wikilove: WikiLove lets people send love to other wiki users in the form of the Internet's most preferred currency, kittens.


 * wikimania_scholarships: Installs and configures Wikimania Scholarships app for local development.


 * wikimediaevents: Configures WikimediaEvents, a MediaWiki extension that uses EventLogging to log certain events.


 * wikimetrics: Wikimetrics is a Wikimedia Foundation developed tool that provides access to the Wikimedia API. It allows users to pull data about a group of usernames (called cohorts) to discover retention rates for those users, how many characters they have added, how many edits they have made, how many pages they have created, etc, all within time periods the Wikimetrics user sets.


 * xhprof: This class enables support for function-level hierarchical profiling of PHP using XHProf. The graphical interface for the profiler is available at /xhprof on the same port as the wiki.


 * zend: Configures the web server to run standard Zend PHP in place of HHVM. Currently required for remote debugging.


 * zero
 * This role provisions ZeroBanner and ZeroPortal extensions for Wikipedia Zero.