MediaWiki-Vagrant/Roles

From MediaWiki.org
Jump to navigation Jump to search

A MediaWiki-Vagrant role is a Puppet manifest that is designed to deploy a software component or suite of related components. To list available roles, run vagrant roles list.

vagrant roles info ROLENAME will provide a brief description of a role.

List of roles[edit]

abusefilter
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
antispoof
apex
apisandbox
This role simply sets up ApiSandbox This extension has been merged into MediaWiki core as of gerrit:209570. Wikis running or upgrading to 1.27 should uninstall this extension
apparmor
babel
betafeatures
Configures BetaFeatures
browsertests
Configures this machine to run the Wikimedia Foundation's set of Selenium browser tests for MediaWiki instances.
buggy
cassandra
categorytree
centralauth
centralnotice
checkuser
chromium
cirrussearch
CirrusSearch implements searching for MediaWiki using Elasticsearch.
cite
Provisions Cite, an extension which adds support for citations and references
citoid
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.
cologneblue
commonsmetadata
This role provisions CommonsMetadata, which adds image metadata extracted from the description page to the imageinfo API.
confirmedit
contactpage
contenttranslation
disambiguator
doublewiki
echo
Configures Echo, a MediaWiki notification framework.
education
Configures the Education Program Program extension & its dependencies.
elk
Provision an ELK stack (ElasticSearch, Logstash, Kibana). Configures MediaWiki to send log messages to the ELK cluster using Monolog and Redis.
embedvideo
eventbus
eventlogging
This role sets up EventLogging for MediaWiki such that events are validated against production schemas but logged locally.
featuredfeeds
flow
Configures Flow, a MediaWiki discussion system.
fss
fundraising
This role configures MediaWiki to use the branch (more or less) currently in use on the Fundraising cluster, 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.
gadgets2
gather
geodata
GeoData is an extension that allows storing coordinates in articles and searching for them.
geodata_elastic
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.
globalblocking
globalcssjs
globalusage
globaluserpage
gpgmail
graph
Enables <graph> tag and Graph: namespace. See info and demo.
graphoid
greystuff
growthexperiments


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.
headertabs
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.
https
hue
iegreview
imagemetrics
inputbox
interwiki
This role installs and enables Extension:Interwiki and sets $wgGroupPermissions['sysop']['interwiki'] = true; in LocalSettings.
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.
kafka
l10nupdate
labeledsectiontransclusion
liquidthreads
livingstyleguide
lzero 
This role provisions ZeroBanner and ZeroPortal extensions for Wikipedia Zero.
massaction
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 rendering server. Enables http://localhost:10042 on the host.
mathsearch
Installs the Extension:MathSearch.
mediawiki
Provisions a MediaWiki instance powered by PHP, MySQL, and redis.
memcached
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.
mobileapp
Configures MobileApp, which produces CSS files and hooks for the Wikimedia Android & iOS Mobile apps.
mobilefrontend
Configures MobileFrontend, the MediaWiki extension which powers Wikimedia mobile sites.
modern
molhandler
monobook
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.
newsletter
newusermessage
notebook
nuke
oathauth
oauth
This role sets up OAuth for MediaWiki. Other OAuth enabled applications can then edit this instance of MediaWiki on its users' behalf.
oozie
openbadges
ores
pagedtiffhandler
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
payments
pdfhandler
phabricator
phptags
Configures Extension:PhpTags, an extension that implements the concept of Magic expressions with PHP language syntax in MediaWiki.
phragile
pipeescape
poem
poolcounter
popups
Provisions Extension:Popups, which shows a popup when people hover over article links.
private
proofreadpage
Configures ProofreadPage, an extension to allow the proofreading of a text in comparison with scanned images.
psr3
quips
raita
renameuser
restbase
sal
sandboxlink
scholarships
score
scribunto
Configures Scribunto, an extension for embedding scripting languages in MediaWiki.
securepoll
semanticextraspecialproperties
semanticmediawiki
semanticresultformats
semantictitle
sentry
shorturl
simple_miser
simple_performant
sitematrix
spark
statsd
svg
swift
templatedata
testwiki
textextracts
Configures TextExtracts, a MediaWiki extension which provides an API for getting text extracts of articles
thumb_on_404
thumbor
timedmediahandler
This role provisions TimedMediaHandler, which displays audio and video files and their captions.
titleblacklist
trafficserver
translate
uls
uploadslink
uploadwizard
Configures a MediaWiki instance with UploadWizard, a JavaScript-driven wizard interface for uploading multiple files.
urlgetparameters
urlshortener
usermerge
variables
varnish
vectorbeta
vipsscaler
visualeditor
Provisions VisualEditor, backed by a local Parsoid instance.
warnings_as_errors
widgets
wikibase_repo
Sets up a plain Wikibase repo installation including all dependent components. It provides a quick way to get ready for hacking on Wikibase code. Sources of the Wikibase extension can be found under /mediawiki/extensions/Wikibase and sources of dependent components are under /mediawiki/extensions/Wikibase/vendor. This role doesn't use any magic such as WikidataBuildResources and doesn't set up any client wikis. If you want a full Wikidata installation including multiple client wikis, use role::wikidata instead.
wikidata
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
wikigrok
wikihiero
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.
wikimediaincubator
wikimediamessages
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.
wikitech
xanalytics
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.
xhprofgui
youtube
zend
Configures the web server to run standard Zend PHP in place of HHVM. Currently required for remote debugging.
zero
zotero

See also[edit]