summaryrefslogtreecommitdiff
path: root/docs/sitescache.txt
blob: 13bf371d20528c02dc47efaceeb38cf7b3dbafee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
MediaWiki's SiteStore can be cached and stored in a flat file,
in a json format. If the SiteStore is frequently accessed, the
file cache may provide a performance benefit over a database
store, even with memcached in front of it.

Configuration:

File-based caching can be enabled by setting $wgSitesCacheFile
to the file path of the cache file.

The file can then be generated with the rebuildSitesCache.php
maintenance script.

Format:

In the sites cache file, sites are listed in a key-value
map, with the key being the site's global id (e.g. "enwiki")
and a key-value map as the value. The site list is wrapped
with in a "sites" key.

Example:

"sites": {
	"aawiktionary": {
		"globalid": "aawiktionary",
		"type": "mediawiki",
		"group": "wiktionary",
		"source": "local",
		"language": "aa",
		"localids": [],
		"config": [],
		"data": {
			"paths": {
				"file_path": "http:\/\/aa.wiktionary.org\/w\/$1",
				"page_path": "http:\/\/aa.wiktionary.org\/wiki\/$1"
			}
		},
		"forward": false,
		"internalid": 2666,
		"identifiers": []
	}
}