summaryrefslogtreecommitdiff
path: root/ikiwiki.setup
blob: c96a45f78d091a23a905d82e5dfd33f3d7e27a14 (plain)
  1. #!/usr/bin/perl
  2. # Configuration file for ikiwiki.
  3. # Passing this to ikiwiki --setup will make ikiwiki generate wrappers and
  4. # build the wiki.
  5. #
  6. # Remember to re-run ikiwiki --setup any time you edit this file.
  7. use IkiWiki::Setup::Standard {
  8.     wikiname => "MyWiki",
  9.     #adminuser => ["yourname", ],
  10.     adminemail => 'me@example.org',
  11.     # Be sure to customise these..
  12.     srcdir => "/path/to/source",
  13.     destdir => "/var/www/wiki",
  14.     url => "http://example.org/wiki",
  15.     cgiurl => "http://example.org/ikiwiki.cgi",
  16.     #templatedir => "/usr/share/ikiwiki/templates",
  17.     #underlaydir => "/usr/share/ikiwiki/basewiki",
  18.     # Subversion stuff.
  19.     #rcs => "svn",
  20.     #historyurl => "http://svn.example.org/trunk/[[file]]",
  21.     #diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
  22.     #svnpath => "trunk",
  23.     # Git stuff.
  24.     #rcs => "git",
  25.     #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
  26.     #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  27.     #gitorigin_branch => "origin",
  28.     #gitmaster_branch => "master",
  29.     # Tla stuff.
  30.     #rcs => "tla"
  31.     #historyurl => ??,
  32.     #diffurl => ??,
  33.     # Mercurial stuff.
  34.     #rcs => "mercurial",
  35.     #historyurl => "http://localhost:8000/log/tip/[[file]]", # hg serve'd local repository
  36.     #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
  37.     # Bazaar stuff.
  38.     #rcs => "bzr",
  39.     #historyurl => "", 
  40.     #diffurl => "http://example.com/revision?start_revid=[[r2]]#[[file]]-s", # using loggerhead
  41.     # Monotone stuff
  42.     #rcs => "monotone",
  43.     #mtnkey => "web\@machine.company.com",
  44.     #historyurl => "http://viewmtn.example.com/",
  45.     #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
  46.     # Set if you want the wiki to sync on update and commit.
  47.     #mtnsync => 0,
  48.     # The path to your workspace (defaults to the srcdir itself)
  49.     # e.g. use if your srcdir is a subdirectory of the workspace.
  50.     #mtnrootdir => "path/to/root/of/workspace",
  51.     # This is a monotone lua hook file used by ikiwiki for
  52.     # inserting conflict markers. By default it will use
  53.     # mtnrootdir/_MTN/mergerc. This hook will be populated with
  54.     # default code the first time you use ikiwiki.  You can
  55.     # change it to alter how conflict markers are inserted.
  56.     #mtnmergerc => "path/to/mergerc",
  57.     wrappers => [
  58.         #{
  59.         #   # The cgi wrapper.
  60.         #   cgi => 1,
  61.         #   wrapper => "/var/www/wiki/ikiwiki.cgi",
  62.         #   wrappermode => "06755",
  63.         #},
  64.         #{
  65.         #   # The svn post-commit wrapper.
  66.         #   # Note that this will overwrite any existing
  67.         #   # post-commit hook script, which may not be
  68.         #   # what you want.
  69.         #   wrapper => "/svn/wikirepo/hooks/post-commit",
  70.         #   wrappermode => "04755",
  71.         #   # Log to syslog since svn post-commit hooks
  72.         #   # hide output and errors.
  73.         #   syslog => 1,
  74.         #},
  75.         #{
  76.         #   # The git post-update wrapper.
  77.         #   # Note that this will overwrite any existing
  78.         #   # post-update hook script, which may not be
  79.         #   # what you want.
  80.         #   wrapper => "/git/wiki.git/hooks/post-update",
  81.         #   wrappermode => "06755",
  82.         #},
  83.     ],
  84.     # Default to generating rss feeds for blogs?
  85.     #rss => 1,
  86.     # Default to generating atom feeds for blogs?
  87.     #atom => 1,
  88.     # Allow generating feeds even if not generated by default?
  89.     #allowrss => 1,
  90.     #allowatom => 1,
  91.     # Urls to ping with XML-RPC when rss feeds are updated
  92.     #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  93.     # Include discussion links on all pages?
  94.     discussion => 1,
  95.     # To exclude files matching a regexp from processing. This adds to
  96.     # the default exclude list.
  97.     #exclude => qr/*\.wav/,
  98.     # To change the extension used for generated html files.
  99.     #htmlext => 'htm',
  100.     # Time format (for strftime)
  101.     #timeformat => '%c',
  102.     # Locale to use. Must be a UTF-8 locale.
  103.     #locale => 'en_US.UTF-8',
  104.     # Only send cookies over SSL connections.
  105.     #sslcookie => 1,
  106.     # Logging settings:
  107.     #verbose => 1,
  108.     syslog => 0,
  109.     # To link to user pages in a subdirectory of the wiki.
  110.     #userdir => "users",
  111.     # To create output files named page.html rather than page/index.html.
  112.     #usedirs => 0,
  113.     # Simple spam prevention: require an account-creation password.
  114.     #account_creation_password => "example",
  115.     # Uncomment to force ikiwiki to run with a particular umask.
  116.     #umask => 022,
  117.     # Default settings for the recentchanges page.
  118.     #recentchangespage => "recentchanges",
  119.     #recentchangesnum => 100,
  120.     # To add plugins, list them here.
  121.     #add_plugins => [qw{goodstuff search wikitext camelcase
  122.     #                   htmltidy fortune sidebar map rst anonok}],
  123.     # If you want to disable any of the default plugins, list them here.
  124.     #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
  125.     # To add a directory to the perl search path, use this.
  126.     #libdir => "/home/me/.ikiwiki/",
  127.     # For use with the tag plugin, make all tags be located under a
  128.     # base page.
  129.     #tagbase => "tag",
  130.     # For use with the search plugin if your estseek.cgi is located
  131.     # somewhere else.
  132.     #estseek => "/usr/lib/estraier/estseek.cgi",
  133.     # For use with the openid plugin, to give an url to a page users
  134.     # can use to signup for an OpenID.
  135.     #openidsignup => "http://myopenid.com/",
  136.     # For use with the mirrorlist plugin, a list of mirrors.
  137.     #mirrorlist => {
  138.     #   mirror1 => "http://hostname1",
  139.     #   mirror2 => "http://hostname2/mirror",
  140.     #},
  141. }