Add a wiki

From Wikitech
Jump to: navigation, search

This page documents the process for adding a new wiki. This includes new languages on sister projects, and wikis for committees, chapters etc.

Preparation

The following steps need to be completed before the wiki database may be created.

Notify

  • Create a Phabricator task for the wiki creation (if one doesn't exist already).
    • It should be tagged with "Wiki-Setup (Create)".
  • Create (if not already) a sub task "Prepare and check storage layer for <new wiki>".
    • It should be tagged with "DBA" and "Cloud-Services".
  • Notify the Operations list. In particular, it needs to be made clear whether the wiki should be public, or private. If public, ops will arrange for the wiki to be replicated to Cloud Services. If private, ops will need to add the wiki to $private_wikis in operations/puppet.git:/manifests/realm.pp.
  • IMPORTANT: If the wiki is a regular public wiki to appear on Cloud Services - you can continue. If the wiki is private and should not be replicated to Cloud Services DO NOT CONTINUE UNTIL YOU HAVE THE OK FROM OPS/DBAs to check no private data is leaked. There are mechanisms in place to prevent that by default, but those should be manually checked.

DNS

First of all, ensure the relevant domain names exist for the new wiki. Make the following changes in a commit for the operations/dns.git repo and submit to Gerrit for review.

  • If it is a language project, ensure the language code is present in /templates/helpers/langs.tmpl. This is shared between all sister projects. If another sister project has the same language already, then this has probably been done already.
  • If it is a subdomain of ".wikimedia.org" domain (chapter wiki or special wiki)
  • Merge the change in Gerrit and run authdns-update.
  • Query the DNS servers to make sure it has been correctly deployed. See DNS#HOWTO for details.
  • For new languages, there is also a need to regenerate zones. Run on ns0, ns1 and ns2: authdns-gen-zones -f /srv/authdns/git/templates /etc/gdnsd/zones && gdnsd checkconf && gdnsd reload-zones

Apache configuration

Apache configuration is located at /modules/mediawiki/files/apache/sites/ in the operations/puppet.git repo.

  • Common configuration:
    • For a new language project, this step is usually not needed as shared configuration already covers it.
    • For a new chapter wiki, add a ServerAlias to the "wikimedia-chapter" virtual host in /wikimedia.conf.
    • For Wikimania wikis, add a ServerAlias to /wikimania.conf.
  • After the change is merged in Gerrit, deploy the configuration change and (if needed) gracefully restart app servers. See Apache# Deploying config for details.
  • If there are additional domains that should point to the same wiki, add it to /redirects/redirects.dat and regenerate /redirects.conf.

Language committee

Determine if this is a new language project or chapter wiki (say something like Spanish Wikibooks), or something else (special wiki or private wiki).

For a new language project, follow the steps below. For all other wikis, go directly to #Install.

Install

IMPORTANT: For Private Wikis

  • Private wiki databases must not be replicated to the Cloud Services DB MySQL instances!
    • Before creating a database for a private wiki, make sure to add the db name to the puppet global array $private_wikis in operations/puppet.git:/manifests/realm.pp.
    • Deploy this config change with puppet and manually restart the Prelabsdb-db MySQL instance (Sanitarium) on the server that will house this wiki's db (most likely s3).
    • If you need help with this, please ask a member of the Ops team for help. This is very important.

MediaWiki configuration

Gather all relevant information about the new project. Each wiki has different requirements (project name, namespaces, extensions to be enabled etc).

Make the following changes on your own checkout of operations/mediawiki-config.git and submit to Gerrit for review:

  • Add the wiki to the relevant dblists (in the dblists directory).
Database list Purpose
s1.dblist
s2.dblist
s3.dblist
s4.dblist
s5.dblist
s6.dblist
s7.dblist
Every wiki must be in one of these.

Database lists of wikis in each MySQL database cluster.
In most cases, wikis should just be added to s3.dblist

all.dblist All wikis must be listed here.
closed.dblist Any closed (no write access, full read access) wikis
deleted.dblist Wiki databases which MediaWiki is no longer configured to access
small.dblist
medium.dblist
large.dblist
Every wiki must be in one of these.

Database lists of wikis arranged into their relevant size.

flaggedrevs.dblist All wikis running the FlaggedRevs extension
securepollglobal.dblist $wgSecurePollCreateWikiGroups wikis: Board Election wikis
visualeditor-nondefault.dblist All wikis where VisualEditor is not enabled by default
commonsuploads.dblist All wikis which should have local uploading soft-disabled. Uploads go to Commons instead.
fishbowl.dblist All fishbowl (restricted write access, full read access) wikis
private.dblist All private (read and write restricted) wikis
wikidata.dblist All wikis running the Wikidata repo
wikidataclient.dblist All wikis running the Wikidata client (most new language-project wikis should start off like this)
wikimania.dblist

wikimedia.dblist wikibooks.dblist

wikinews.dblist wikipedia.dblist

wikiquote.dblist wikisource.dblist

wikiversity.dblist wikivoyage.dblist

wiktionary.dblist special.dblist

Every wiki must be in one of these.

Sister project, Wikimania, chapter, or special.

NOTE: Some wikis maybe in special and one other list.

Database creation

Once the above is reviewed, merged and pull down on the deployment host also pull it down on terbium (scap pull), but do not yet deploy to main app servers until after the database is created.

Now it's time to actually create the database. The installation script also performs other tasks, such as notifying the "newprojects" mailing list. The installation script must be run from terbium (not the deployment host). If the wiki is going to be a Wikidata client, make sure it's present in the wikidataclient.dblist file and that the new version of that file has been pulled down on terbium **before** running the installation script, or things will break.

The syntax is as follows:

mwscript extensions/WikimediaMaintenance/addWiki.php --wiki=aawiki <languagecode> <projectname> <databasename> <domain>

  • For a new language projects - for example a Spanish Wikinews:
    mwscript extensions/WikimediaMaintenance/addWiki.php --wiki=aawiki es wikinews eswikinews es.wikinews.org
  • For a new chapters wikis - for example a Finnish chapter wiki:
    mwscript extensions/WikimediaMaintenance/addWiki.php --wiki=aawiki fi wikimedia fiwikimedia fi.wikimedia.org
  • For non-standard special wikis (such as committees, or unique projects like meta or commons) - for example strategy.wikimedia.org:
    mwscript extensions/WikimediaMaintenance/addWiki.php --wiki=aawiki en wikimedia strategywiki strategy.wikimedia.org
  1. Merge the config change in Gerrit, and pull it onto tin.
  2. Verify that the *.dblist files now contain the new wiki.
  3. Pull the whole on mwdebug1002 and terbium (wasat) through scap pull
  4. Run the addWiki maintenance script, as described above (important to do before any sync of dblists or wikiversions, as some components like login use that)
  5. Run scap sync-file dblists to synchronize all database lists
  6. Verify wikiversions.json is sane.
  7. Run scap sync-wikiversions to synchronize the version number to use for this wiki
  8. Run scap sync-file wmf-config/InitialiseSettings.php
  9. Run scap sync-file static/images/project-logos/
  10. If adding a new language code, run scap sync-file langlist (this must be done before deploying the updated interwiki cache - step 10)
  11. Unless it's a language project, add the project to the meta:Interwiki map.
  12. Regenerate the interwiki cache and deploy it. (For all new wikis, not just new language projects.)
    • mwscript extensions/WikimediaMaintenance/dumpInterwiki.php --protocolrelative > wmf-config/interwiki.php
    • Commit change, upload to Gerrit for review
    • Review and merge.
    • scap sync-file wmf-config/interwiki.php
    • Edit meta:Interwiki map and update when the last update was.

RESTBase

RESTBase is a service providing a RESTful API for the projects' wikis. To enable it to serve the new wiki as well, create a patch for mediawiki/services/restbase/deploy adding its domain to the appropriate section in RESTBase's configuration. Add Mobrovac to review the patch, and wait for it to get merged. This will then require a restart of the RB service across the cluster, which can be done by ops or restbase-admins/restbase-roots.

Parsoid

Parsoid has its own copy of SiteMatrix (lib/config/sitematrix.json), which needs updating using tools/fetch-sitematrix.js in the mediawiki/services/parsoid repository. This can only be run after the wiki has been created and deployed.

Then, once merged, it must be deployed; if not, loading VisualEditor will fail with errors such as "Failed to load resource: the server responded with a status of 404".

Search

You shouldn't have to do much (maybe adjust shard sizes preemptively if it'll be big), the index should be automatically created by addWiki.php. See Search/New#Adding new wikis for more information.

Swift

Necessary changes are made automatically by the addWiki.php script.

Cloud Services

  • Create a patch for operations/puppet to add the database to the correct list in hieradata/common/profile/openstack/base/pdns/labsdb.yaml
  • Once it is replicating to the labsdb* servers:
    • Run maintain-views --databases $wiki --debug on each replica server
    • Insert a new row in meta_p.wiki for the new wiki by running /usr/local/sbin/maintain-meta_p --databases $wiki.
      • Note: On the labsdb100[13] hosts, you will need to add --mysql-socket /tmp/mysql.sock to the maintain-views and maintain-meta_p commands.
    • Add the wikidb Wiki Replicas service name:
      $ ssh labcontrol1001.wikimedia.org
      $ source <(sudo cat ~root/novaenv.sh)
      $ /usr/local/sbin/wikireplica_dns --aliases --shard <sN>
      

Post-install

Wikidata

Only needed if the new wiki is supposed to be a Wikidata client.

Make sure that the language code appears in the file wmf-config/InterwikiSortOrders.php in the operations/mediawiki-config repo. (Example: https://gerrit.wikimedia.org/r/359810)

In order to be able to link the new wiki from Wikidata, and to allow interwiki links from Wikidata to the new wiki, run extensions/Wikidata/extensions/Wikibase/lib/maintenance/populateSitesTable.php --force-protocol https on at least all Wikidata clients (including wikidatawiki itself and testwikidata).

foreachwikiindblist wikidataclient extensions/Wikidata/extensions/Wikibase/lib/maintenance/populateSitesTable.php --force-protocol https

That script is known to be troublesome, you might want to ask Marius (hoo) or Katie (aude) run it for you or just create a ticket (that may be done anytime after the wiki was created).

Beware: The script sometimes fails with a duplicate key conflict. In that case, go to the wiki's master database and empty the sites and site_identifiers tables, then run the script again. It's probably also wise to backup these tables from Wikidata and at least one Wikipedia before running the script across the whole fleet. Breaking the sites, site_identifiers tables will break page rendering of many wikis!

WikimediaMessages

Translatable project name

Add a message with the wiki name to extensions/WikimediaMessages/i18n/wikimediaprojectnames/en.json and qqq.json. The message keys should include the wiki database name (WIKI_DBNAME below) and official "human readable" name (WIKI_NAME below) as follows:

en.json
Key Message
project-localized-name-WIKI_DBNAME WIKI_NAME

For example, "project-localized-name-enwiki": "English Wikipedia",

qqq.json
Key Message
project-localized-name-WIKI_DBNAME {{ProjectNameDocumentation|url=WIKI_URL|name=WIKI_NAME|language=WIKI_LANG}}

For example, "project-localized-name-enwiki": "{{ProjectNameDocumentation|url=https://en.wikipedia.org|name=English Wikipedia|language=en}}",

Interwiki search result title

If this is a new language Wikipedia, add a message with the wiki name to extensions/WikimediaMessages/i18n/wikimediainterwikisearchresults/en.json and qqq.json in the list of search-interwiki-results messages.

Analytics

If the wiki is not private, not a Wikimania conference wiki, and not special wiki like usability/outreach/login/vote/strategy/etc., send a change proposal to analytics/refinery.git that adds the wiki to static_data/pageview/whitelist/whitelist.tsv

Incubator

If there's something to import (as is often the case in new language projects), someone will do so. Their process is described at Incubator:Importing from Incubator (logged at Incubator:Site creation log).

cxserver

For new Wikipedia projects only: Add the language code to the ContentTranslation registry - mediawiki/services/cxserver repository, files registry.yaml (included by config.dev.yaml) and registry.wikimedia.yaml (included by config.prod.yaml), in the source and target sections in each.

Once merged to master, ping the project to deploy the change. That requires to sync repositories, ie to update mediawiki/services/cxserver/deploy to match mediawiki/services/cxserver. See https://gerrit.wikimedia.org/r/#/c/303763/ for an example commit.

Clean up interwiki links

After any import Incubator is completed, Inform the community and make a Phabricator task for removing old interwiki links and migrating them to Wikidata (For example T134991 for edits such as d:Special:Diff/336584053 and jam:Special:Diff/12330). You can do it by yourself using interwikidata.py in pywikibot.

python pwb.py scripts/interwikidata.py -lang:LANGCODE -clean -start:! -always

Tell wikistats Cloud VPS project to add the wiki

Create a Phabricator task (subtask of the main task to create the wiki) with the tag "VPS-project-wikistats" and just ask for the wiki to be added. (What needs to be done can be seen f.e. in https://phabricator.wikimedia.org/T140970#2531977)

See also