Welcome to xTools!¶

Pre-requisites¶

Xtools requires the following to run:

• A recent version of Linux (Windows servers are supported, however; you must enable the app.load_stylesheets_from_cdn if you want it to look nice).
• PHP 5.5.9+ (not tested on PHP7)
  • JSON must be enabled.
  • ctype needs to be enabled
  • You must have date.timezone set in php.ini.
  • PDO including the driver for the database you want to use
  • Curl must be enabled.
• Composer 1.0.0+

Installation¶

To install xTools, please follow these steps:

1. Download the repository into your webserver root.
2. Run composer install
3. Start your web server.
4. Visit your domain in a browser. You should see the xTools landing page
5. In order to update the cache after making configuration changes, run sudo ./clear_cache.sh from the webserver root.

Configuration¶

As part of the installation of xTools, composer install or composer update may prompt you for configuration options. This is a definition of those options.

• database_host - Hostname for the server with the symfony database
• database_port - Port for the server with the symfony database
• database_name - Database Name for the server with the symfony database
• database_user - Username for the server with the symfony database
• database_password - Password for the server with the symfony database
• database_replica_host - Hostname for the server with the MediaWiki database
• database_replica_port - Port for the server with the MediaWiki database
• database_replica_name - Database Name for the server with the MediaWiki database
• database_replica_user - Username for the server with the MediaWiki database
• database_replica_password - Password for the server with the MediaWiki database
• database_meta_name - Database Name for the server with the meta_p table (This is optional if app.single_wiki is set)
• mailer_transport - Software for the mailer
• mailer_host - Hostname for the mailer
• mailer_user - Username for the mailer software
• mailer_password - Password for the mailer software
• secret - A secret key that’s used to generate certain security-related tokens
• app.noticeDisplay - Display the notice or not
• app.noticeStyle - Style of the notice banner. Available options: “error,” “warning,” “succeess,” “info.”
• app.noticeText - Message shown to the user. If you provide a valid intuition key, it will display that message instead
• app.replag_threshold - Number of seconds to consider the replicas as “lagged”, and show a warning to the user that the data may be out of date
• enable.ec - Enable “Edit Counter” tool
• enable.articleinfo - Enable “Article Information” tool
• enable.pages - Enable “Pages Created” tool
• enable.topedits - Enable “Top Edits” tool
• enable.rangecontribs - Enable “Range Contributions” tool
• enable.blame - Enable “Article Blamer” tool
• enable.autoedits - Enable “Automated Edits” tool
• enable.autoblock - Enable “Autoblock” tool
• enable.adminstats - Enable “Admin Statistics” tool
• enable.adminscore - Enable “Admin Score” tool
• enable.rfa - Enable “RfX Analysis” tool
• enable.rfap - Enable “RfX Vote Calculator” tool
• enable.bash - Enable “Quote Database” tool
• enable.sc - Enable “Plain, Dirty, Simple Edit Counter” tool
• app.load_stylesheets_from_cdn - Whether to load our stylesheets and scripts from a CDN. This is required if xTools is installed on a Windows server
• app.single_wiki - Point xTools to a single wiki, instead of using a meta database. This ignores database_meta_name above.
• app.is_labs - Whether xTools lives on the Wikimedia Foundation Labs environment. This should be set to false.
• wiki_url - URL to use if app.single_wiki is enabled. The title of pages is attached to the end.

Development¶

To contribute to the development of xTools, you may fork us on GitHub. A few things to be aware of first:

1. xTools is based on Symfony 3.0. We use Twig as our template engine. Symfony is a full MVC system.

1. The controllers are located at src/AppBundle/controller. They are sorted by tool
2. The twig templates are located at app/resources/views. They are sorted by tool.

2. We use the @Route syntax to configure routes.
3. Every tool requires a twig directory and one controller. Also, core parts of xTools require the tool to be registered within app/config/tools.yml.