testing

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

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index bf1aa3703a41d8d48f1a66a98e849929947d5664..7d0eb71fe32d5779937a896b7f47a98253edd903 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -8,27 +8,37 @@
 use IkiWiki::Setup::Standard {
        wikiname => "MyWiki",
        #adminuser => ["yourname", ],
 use IkiWiki::Setup::Standard {
        wikiname => "MyWiki",
        #adminuser => ["yourname", ],

-       adminemail => 'me@myhost',
+       adminemail => 'me@example.org',

        
        # Be sure to customise these..
        srcdir => "/path/to/source",
        destdir => "/var/www/wiki",
        
        
        # Be sure to customise these..
        srcdir => "/path/to/source",
        destdir => "/var/www/wiki",
        

-       url => "http://myhost/wiki",
-       cgiurl => "http://myhost/ikiwiki.cgi",
+       url => "http://example.org/wiki",
+       cgiurl => "http://example.org/ikiwiki.cgi",

        #templatedir => "/usr/share/ikiwiki/templates",
        
        # Subversion stuff.
        rcs => "svn",
        #templatedir => "/usr/share/ikiwiki/templates",
        
        # Subversion stuff.
        rcs => "svn",

-       #historyurl => "http://svn.myhost/trunk/[[file]]",
-       #diffurl => "http://svn.someurl/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
+       #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.
        #rcs => "git",
        svnrepo => "/svn/wiki",
        svnpath => "trunk",
 
        # Git stuff.
        #rcs => "git",

-       #historyurl => "http://git.host/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
-       #diffurl => "http://git.host/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
+       #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]]",
+
+       # Tla stuff.
+       #rcs => "tla"
+       #historyurl => ??,
+       #diffurl => ??,
+
+       # Mercurial stuff.
+       #rcs => "mercurial",
+       #historyurl => "http://localhost:8000/", # hg serve'd local repository
+       #diffurl => "http://localhost:8000/?fd=[[changeset]];file=[[file]]",

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


@@ -52,7 +62,7 @@ use IkiWiki::Setup::Standard {
                #       # Note that this will overwrite any existing
                #       # post-update hook script, which may not be
                #       # what you want.
                #       # Note that this will overwrite any existing
                #       # post-update hook script, which may not be
                #       # what you want.

-               #       wrapper => "/git/wikirepo/.git/hooks/post-update",
+               #       wrapper => "/git/wiki.git/hooks/post-update",

                #       wrappermode => "04755",
                #       # Enable mail notifications of commits.
                #       notify => 1,
                #       wrappermode => "04755",
                #       # Enable mail notifications of commits.
                #       notify => 1,


@@ -61,8 +71,10 @@ use IkiWiki::Setup::Standard {
        
        # Can anonymous web users edit pages?
        #anonok => 1,
        
        # Can anonymous web users edit pages?
        #anonok => 1,

-       # Generate rss feeds for pages?
+       # Generate rss feeds for blogs?

        rss => 1,
        rss => 1,

+       # Generate atom feeds for blogs?
+       atom => 1,

        # Urls to ping with XML-RPC when rss feeds are updated
        #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
        # Include discussion links on all pages?
        # Urls to ping with XML-RPC when rss feeds are updated
        #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
        # Include discussion links on all pages?


@@ -74,6 +86,8 @@ use IkiWiki::Setup::Standard {
        #timeformat => '%c',
        # Locale to use. Must be a UTF-8 locale.
        #locale => 'en_US.UTF-8',
        #timeformat => '%c',
        # Locale to use. Must be a UTF-8 locale.
        #locale => 'en_US.UTF-8',

+       # Only send cookies over SSL connections.
+       #sslcookie => 1,

        # Logging settings:
        verbose => 0,
        syslog => 0,
        # Logging settings:
        verbose => 0,
        syslog => 0,


@@ -81,7 +95,19 @@ use IkiWiki::Setup::Standard {
        # To add plugins, list them here.
        #add_plugins => [qw{meta tag pagecount brokenlinks search smiley
        #                   wikitext camelcase pagestats htmltidy fortune
        # To add plugins, list them here.
        #add_plugins => [qw{meta tag pagecount brokenlinks search smiley
        #                   wikitext camelcase pagestats htmltidy fortune

-       #                   sidebar map rst}],
+       #                   sidebar map rst toc linkmap openid}],

        # If you want to disable any of the default plugins, list them here.
        #disable_plugins => [qw{inline htmlscrubber}],
        # If you want to disable any of the default plugins, list them here.
        #disable_plugins => [qw{inline htmlscrubber}],

+
+       # 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 
+       # 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/",

 }
 }