summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/websetup.mdwn19
-rw-r--r--doc/setup.mdwn5
2 files changed, 22 insertions, 2 deletions
diff --git a/doc/plugins/websetup.mdwn b/doc/plugins/websetup.mdwn
new file mode 100644
index 000000000..1e4ed4d0c
--- /dev/null
+++ b/doc/plugins/websetup.mdwn
@@ -0,0 +1,19 @@
+[[!template id=plugin name=websetup core=0 author="[[Joey]]"]]
+[[!tag type/useful]]
+
+This plugin allows wiki admins to configure the wiki using a web interface,
+rather than editing the setup file directly. A "Wiki Setup" button is added to the
+admins' preferences page.
+
+Most settings can be modified using the web interface. Some settings are
+not considered safe enough to be manipulated over the web; these are still
+shown, by default, but cannot be modified. To hide them, set `websetup_show_unsafe`
+to false in the setup file. A few settings have too complex a data type
+to be configured via the web.
+
+The web interface can also be used to enable and disable plugins, with
+limitations. The plugin for the [[revision_control_system|rcs]] being used
+cannot be enabled/disabled, and no other rcs plugins can be enabled. A few
+problematic/unsafe plugins are also blacklisted from being enabled. Other
+plugins that should not be enabled/disabled via the web interface can be
+listed in `websetup_force_plugins` in the setup file.
diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 2989485f9..2d3942124 100644
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -9,8 +9,9 @@ If you're not, see the [[download]] and [[install]] pages.
## Quick start
-If you'd like to set up a wiki now, and learn more later, just run this command
-and answer a couple of questions.
+If you'd like to set up a wiki now, and learn more later, and you have
+ikiwiki 2.60 or better installed, just run this command and answer a couple
+of questions.
% ikiwiki -setup /etc/ikiwiki/auto.setup
What will the wiki be named? mywiki