(no commit message)

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

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 864dc928ff2dd01ebf357979a3431e67a3619842..31a60b9ca88e56f70ea6dc8a42260d5ee726560f 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",
        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",
 
        #templatedir => "/usr/share/ikiwiki/templates",
        #underlaydir => "/usr/share/ikiwiki/basewiki",
 


@@ -40,22 +40,24 @@ use IkiWiki::Setup::Standard {
 
        # Mercurial stuff.
        #rcs => "mercurial",
 
        # Mercurial stuff.
        #rcs => "mercurial",

-       #historyurl => "http://localhost:8000/", # hg serve'd local repository
-       #diffurl => "http://localhost:8000/?fd=[[changeset]];file=[[file]]",
+       #historyurl => "http://localhost:8000/log/tip/[[file]]", # hg serve'd local repository
+       #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
+
+       # Bazaar stuff.
+       #rcs => "bzr",
+       #historyurl => "", 
+       #diffurl => "http://example.com/revision?start_revid=[[r2]]#[[file]]-s", # using loggerhead

 
        # Monotone stuff
        #rcs => "monotone",
        #mtnkey => "web\@machine.company.com",
 
        # Monotone stuff
        #rcs => "monotone",
        #mtnkey => "web\@machine.company.com",

-       # Monotone options
-       #mtnsync => 0,                              # set this if you want the wiki to sync on update and commit
-       #mtnrootdir => "path/to/root/of/workspace", # The path to your workspace (defaults to the srcdir itself)
-                                                   # e.g. use if your srcdir is a subdirectory of the workspace
-       #mtnbinpath => "path/to/montone/binary",    # by default we just use "mtn" and assume it is in your path.
-       #mtnmergerc => "path/to/mergerc",           # this is a monotone lua hook file used by ikiwiki for
-                                                   # inserting conflict markers.  By default we use
-                                                   # mtnrootdir/_MTN/mergerc.  This hook will be populated with
-                                                   # default code the first time you use ikiwiki.  You can
-                                                   # change it to alter how conflict markers are inserted.
+       #historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
+       #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
+       # Set if you want the wiki to sync on update and commit.
+       #mtnsync => 0,
+       # The path to your workspace (defaults to the srcdir itself)
+       # e.g. use if your srcdir is a subdirectory of the workspace.
+       #mtnrootdir => "path/to/root/of/workspace",

 
        wrappers => [
                #{
 
        wrappers => [
                #{


@@ -71,8 +73,6 @@ use IkiWiki::Setup::Standard {
                #       # what you want.
                #       wrapper => "/svn/wikirepo/hooks/post-commit",
                #       wrappermode => "04755",
                #       # 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,
                #       # Log to syslog since svn post-commit hooks
                #       # hide output and errors.
                #       syslog => 1,


@@ -83,23 +83,29 @@ use IkiWiki::Setup::Standard {
                #       # post-update hook script, which may not be
                #       # what you want.
                #       wrapper => "/git/wiki.git/hooks/post-update",
                #       # post-update hook script, which may not be
                #       # what you want.
                #       wrapper => "/git/wiki.git/hooks/post-update",

-               #       wrappermode => "04755",
-               #       # Enable mail notifications of commits.
-               #       notify => 1,
+               #       wrappermode => "06755",
+               #},
+               #{
+               #       # The monotone netsync hook.
+               #       wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
+               #       wrappermode => "06755",

                #},
        ],
 
                #},
        ],
 

-       # Generate rss feeds for blogs?
-       rss => 1,
-       # Generate atom feeds for blogs?
-       atom => 1,
-       # Urls to ping with XML-RPC when rss feeds are updated
+       # Default to generating rss feeds for pages with feeds?
+       #rss => 1,
+       # 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 feeds are updated

        #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
        # Include discussion links on all pages?
        discussion => 1,
        # To exclude files matching a regexp from processing. This adds to
        # the default exclude list.
        #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
        # Include discussion links on all pages?
        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)
        # To change the extension used for generated html files.
        #htmlext => 'htm',
        # Time format (for strftime)


@@ -117,22 +123,42 @@ use IkiWiki::Setup::Standard {
        #usedirs => 0,
        # Simple spam prevention: require an account-creation password.
        #account_creation_password => "example",
        #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.
+       #recentchangespage => "recentchanges",
+       #recentchangesnum => 100,
+       # Use new '!'-prefixed preprocessor directive syntax
+       #prefix_directives => 1,
+       # 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
        #                   htmltidy fortune sidebar map rst anonok}],
        # If you want to disable any of the default plugins, list them here.
        #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
 
        # To add plugins, list them here.
        #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 passwordauth openid}],

-       # To add a directory to the perl searh path, use this.
+       # To add a directory to the perl search path, use this.

        #libdir => "/home/me/.ikiwiki/",
        #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 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.
        # 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.
 
        # For use with the openid plugin, to give an url to a page users
        # can use to signup for an OpenID.


@@ -143,4 +169,38 @@ use IkiWiki::Setup::Standard {
        #       mirror1 => "http://hostname1",
        #       mirror2 => "http://hostname2/mirror",
        #},
        #       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.
+       # Enable aggregation to internal pages. New wikis should set this to 1,
+       # but if you use aggregate already, read the aggregate plugin docs
+       # before enabling it.
+       #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
+       # 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 -",

 }
 }