ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / websetup.mdwn
1 [[!template id=plugin name=websetup core=0 author="[[Joey]]"]]
2 [[!tag type/web]]
3
4 This plugin allows wiki admins to configure the wiki using a web interface,
5 rather than editing the setup file directly. A "Setup" button is added
6 to the admins' preferences page.
7
8 Warning: This plugin rewrites your setup file. Any comments or unusual
9 things (such as perl code) in the setup file will not be preserved. Also,
10 it will only work correctly with new format setup files, as introduced in
11 ikiwiki 2.60. Older setup files have a "wrappers" section, which will not
12 be properly preserved if this plugin is used.
13
14 Most settings can be modified using the web interface. Plugins can be
15 enabled and disabled using it too. Some settings are not considered safe
16 enough to be manipulated over the web; these are still shown, by default,
17 but cannot be modified. To hide them, set `websetup_show_unsafe` to false
18 in the setup file. A few settings have too complex a data type to be
19 configured via the web. To mark additional settings as unsafe, you can
20 list them in `websetup_unsafe`.
21
22 Plugins that should not be enabled/disabled via the web interface can be
23 listed in `websetup_force_plugins` in the setup file.
24
25 When the setup is saved, the setup file will be rewritten with the new
26 settings, and the wiki will be refreshed, or rebuilt, to make the setup
27 changes take effect.