meta plugin: if uuid looks like it is in fact a UUID, prepend "urn:uuid" (otherwise...

[git.ikiwiki.info.git] / doc / ikiwiki.setup

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 99c81cf040107e36ebdd3cb86a5656a5fc9029c0..6d327fd9861d298cda18b5aaefa74d6a35854922 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -15,7 +15,7 @@ use IkiWiki::Setup::Standard {
        destdir => "/var/www/wiki",
 
        url => "http://example.org/wiki",
-       cgiurl => "http://example.org/ikiwiki.cgi",
+       cgiurl => "http://example.org/wiki/ikiwiki.cgi",
        #templatedir => "/usr/share/ikiwiki/templates",
        #underlaydir => "/usr/share/ikiwiki/basewiki",
 
@@ -23,6 +23,7 @@ use IkiWiki::Setup::Standard {
        #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",
 
        # Git stuff.
@@ -91,14 +92,14 @@ use IkiWiki::Setup::Standard {
                #},
        ],
 
-       # Default to generating rss feeds for blogs?
+       # Default to generating rss feeds for pages with feeds?
        #rss => 1,
-       # Default to generating atom feeds for blogs?
+       # Default to generating atom feeds for pages with feeds?
        #atom => 1,
        # Allow generating feeds even if not generated by default?
        #allowrss => 1,
        #allowatom => 1,
-       # Urls to ping with XML-RPC when rss feeds are updated
+       # Urls to ping with XML-RPC when feeds are updated
        #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
        # Include discussion links on all pages?
        discussion => 1,
@@ -122,6 +123,8 @@ use IkiWiki::Setup::Standard {
        #usedirs => 0,
        # Simple spam prevention: require an account-creation password.
        #account_creation_password => "example",
+       # Cost of generating a password using Authen::Passphrase::BlowfishCrypt
+       #password_cost => 8,
        # Uncomment to force ikiwiki to run with a particular umask.
        #umask => 022,
        # Default settings for the recentchanges page.
@@ -132,6 +135,8 @@ use IkiWiki::Setup::Standard {
        # Attempt to make hardlinks to source files instead of copying them.
        # Useful if the wiki contains large media files.
        #hardlink => 1,
+       # Enable use of multimarkdown features in .mdwn files.
+       #multimarkdown => 1,
 
        # To add plugins, list them here.
        #add_plugins => [qw{goodstuff search wikitext camelcase
@@ -140,14 +145,20 @@ use IkiWiki::Setup::Standard {
        #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
        # To add a directory to the perl search path, use this.
        #libdir => "/home/me/.ikiwiki/",
+       
+       # To override environment variable settings, you can list values here.
+       #ENV => {
+       #       TZ => "America/New_York",
+       #       PATH => "/home/me/bin:/usr/local/bin:/usr/bin:/bin",
+       #},
 
        # 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
+       # For use with the search plugin if the omega cgi is located
        # somewhere else.
-       #estseek => "/usr/lib/estraier/estseek.cgi",
+       #omega_cgi => "/usr/lib/cgi-bin/omega/omega",
 
        # For use with the openid plugin, to give an url to a page users
        # can use to signup for an OpenID.
@@ -158,4 +169,34 @@ use IkiWiki::Setup::Standard {
        #       mirror1 => "http://hostname1",
        #       mirror2 => "http://hostname2/mirror",
        #},
+       
+       # For use with the anonok plugin, a PageSpec specifying what
+       # pages anonymous users can edit
+       #anonok_pagespec => "*",
+       
+       # For use with the aggregate plugin, to allow aggregation to be
+       # triggered via the web.
+       #aggregate_webtrigger => 1,
+       
+       # For use with the pinger plugin, how many seconds to wait before
+       # timing out.
+       #pinger_timeout => 15.
+       
+       # For use with the amazon S3 plugin, your public access key id.
+       #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
+       # And a file holding your secret key. This file *must* not be
+       # readable by others!
+       #amazon_s3_key_file => "/home/me/.hide/.s3_key
+       # The globally unique name of the bucket to use to store the wiki.
+       #amazon_s3_bucket => "mywiki",
+       # A prefix to prepend to each page name.
+       #amazon_s3_prefix => "wiki/",
+       # Uncomment to use the S3 European datacenter.
+       #amazon_s3_location => "EU",
+       # Uncomment if you need to store each index file twice.
+       #amazon_s3_dupindex => 1,
+       
+       # For use with the attachment plugin, a program that returns
+       # nonzero if its standard input contains an virus.
+       #virus_checker => "clamdscan -",
 }