document aggregateinternal

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

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index e85518849874c313a30e9bacb0cabf6eab7319ae..140216c19d0be549d488e70ff6301efa51ee82a3 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",
 
@@ -123,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.
@@ -133,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
@@ -141,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.
@@ -164,8 +174,11 @@ use IkiWiki::Setup::Standard {
        # pages anonymous users can edit
        #anonok_pagespec => "*",
        
-       # For use with the aggregate plugin, to allow aggregation to be
-       # triggered via the web.
+       # For use with the aggregate plugin.
+       # Enable aggregation to internal pages. Read aggregate plugin docs
+       # before enabling.
+       #aggregateinternal => 1,
+       # Allow aggregation to be triggered via the web.
        #aggregate_webtrigger => 1,
        
        # For use with the pinger plugin, how many seconds to wait before
@@ -185,4 +198,8 @@ use IkiWiki::Setup::Standard {
        #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 -",
 }