* Fix graphviz plugin to not try to read images as utf-8; they might

[ikiwiki.git] / doc / ikiwiki.setup

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 7d0eb71fe32d5779937a896b7f47a98253edd903..a772ca60b703e8708ca8ca9bcb995de9fbe0bf0a 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -1,6 +1,6 @@
 #!/usr/bin/perl
 # Configuration file for ikiwiki.
-# Passing this to ikiwiki --setup will make ikiwiki generate wrappers and 
+# Passing this to ikiwiki --setup will make ikiwiki generate wrappers and
 # build the wiki.
 #
 # Remember to re-run ikiwiki --setup any time you edit this file.
@@ -9,26 +9,29 @@ use IkiWiki::Setup::Standard {
        wikiname => "MyWiki",
        #adminuser => ["yourname", ],
        adminemail => 'me@example.org',
-       
+
        # Be sure to customise these..
        srcdir => "/path/to/source",
        destdir => "/var/www/wiki",
-       
+
        url => "http://example.org/wiki",
        cgiurl => "http://example.org/ikiwiki.cgi",
        #templatedir => "/usr/share/ikiwiki/templates",
-       
+       #underlaydir => "/usr/share/ikiwiki/basewiki",
+
        # Subversion stuff.
-       rcs => "svn",
+       #rcs => "svn",
        #historyurl => "http://svn.example.org/trunk/[[file]]",
        #diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
-       svnrepo => "/svn/wiki",
-       svnpath => "trunk",
+       #svnrepo => "/svn/wiki",
+       #svnpath => "trunk",
 
        # Git stuff.
        #rcs => "git",
        #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
        #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
+       #gitorigin_branch => "origin",
+       #gitmaster_branch => "master",
 
        # Tla stuff.
        #rcs => "tla"
@@ -47,16 +50,19 @@ use IkiWiki::Setup::Standard {
                #       wrapper => "/var/www/wiki/ikiwiki.cgi",
                #       wrappermode => "06755",
                #},
-               {
-                       # The svn post-commit wrapper.
-                       # Note that this will overwrite any existing
-                       # post-commit hook script, which may not be
-                       # what you want.
-                       wrapper => "/svn/wikirepo/hooks/post-commit",
-                       wrappermode => "04755",
-                       # Enable mail notifications of commits.
-                       notify => 1,
-               },
+               #{
+               #       # The svn post-commit wrapper.
+               #       # Note that this will overwrite any existing
+               #       # post-commit hook script, which may not be
+               #       # what you want.
+               #       wrapper => "/svn/wikirepo/hooks/post-commit",
+               #       wrappermode => "04755",
+               #       # Enable mail notifications of commits.
+               #       notify => 1,
+               #       # Log to syslog since svn post-commit hooks
+               #       # hide output and errors.
+               #       syslog => 1,
+               #},
                #{
                #       # The git post-update wrapper.
                #       # Note that this will overwrite any existing
@@ -68,9 +74,7 @@ use IkiWiki::Setup::Standard {
                #       notify => 1,
                #},
        ],
-       
-       # Can anonymous web users edit pages?
-       #anonok => 1,
+
        # Generate rss feeds for blogs?
        rss => 1,
        # Generate atom feeds for blogs?
@@ -81,7 +85,9 @@ use IkiWiki::Setup::Standard {
        discussion => 1,
        # To exclude files matching a regexp from processing. This adds to
        # the default exclude list.
-       #exclude => qr/\*.wav/,
+       #exclude => qr/*\.wav/,
+       # To change the extension used for generated html files.
+       #htmlext => '.htm',
        # Time format (for strftime)
        #timeformat => '%c',
        # Locale to use. Must be a UTF-8 locale.
@@ -89,25 +95,36 @@ use IkiWiki::Setup::Standard {
        # Only send cookies over SSL connections.
        #sslcookie => 1,
        # Logging settings:
-       verbose => 0,
+       #verbose => 1,
        syslog => 0,
-       
+       # To link to user pages in a subdirectory of the wiki.
+       #userdir => "users",
+       # To create output files named page.html rather than page/index.html.
+       #usedirs => 0,
+       # Simple spam prevention: require an account-creation password.
+       #account_creation_password => "example",
+
        # To add plugins, list them here.
-       #add_plugins => [qw{meta tag pagecount brokenlinks search smiley
-       #                   wikitext camelcase pagestats htmltidy fortune
-       #                   sidebar map rst toc linkmap openid}],
+       #add_plugins => [qw{goodstuff search wikitext camelcase
+       #                   htmltidy fortune sidebar map rst anonok}],
        # If you want to disable any of the default plugins, list them here.
-       #disable_plugins => [qw{inline htmlscrubber}],
+       #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
 
        # For use with the tag plugin, make all tags be located under a
        # base page.
-       #tagbase => "tag".
-       
-       # For use with the search plugin if your estseek.cgi is located 
+       #tagbase => "tag",
+
+       # For use with the search plugin if your estseek.cgi is located
        # somewhere else.
        #estseek => "/usr/lib/estraier/estseek.cgi",
-       
+
        # For use with the openid plugin, to give an url to a page users
        # can use to signup for an OpenID.
        #openidsignup => "http://myopenid.com/",
+
+       # For use with the mirrorlist plugin, a list of mirrors.
+       #mirrorlist => {
+       #       mirror1 => "http://hostname1",
+       #       mirror2 => "http://hostname2/mirror",
+       #},
 }