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