ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / mirrorlist.mdwn
1 [[!template id=plugin name=mirror author="[[Joey]]"]]
2 [[!tag type/web]]
3
4 This plugin allows adding links a list of mirrors to each page in the
5 wiki. For each mirror, a name and an url should be specified. Pages are
6 assumed to exist in the same location under the specified url on each
7 mirror.
8
9 In case the `usedirs` setting is not the same on all your mirrors, or
10 if it is not the same on your local wiki as on the mirror a
11 possibility is to let each mirror's ikiwiki CGI find out the correct
12 target page url themselves; in that case the mirrors urls must be set
13 to their ikiwiki CGI url instead of their base url. Example:
14
15         mirrorlist_use_cgi => 1,
16         mirrorlist => {
17                 'mirror1' => 'https://mirror.example.org/ikiwiki.cgi',
18                 'mirror2' => 'https://mirror2.example.org/ikiwiki.cgi',
19         },
20
21 The mirrors must have the ikiwiki CGI and the [[goto]] plugin enabled
22 for this to work.