summaryrefslogtreecommitdiff
path: root/ikiwiki.setup
blob: 2ad1cefab62a2761d91b71065d61456ac46e1aec (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.     # Git stuff.
  19.     #rcs => "git",
  20.     #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
  21.     #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  22.     #gitorigin_branch => "origin",
  23.     #gitmaster_branch => "master",
  24.     wrappers => [
  25.         #{
  26.         #   # The cgi wrapper.
  27.         #   cgi => 1,
  28.         #   wrapper => "/var/www/wiki/ikiwiki.cgi",
  29.         #   wrappermode => "06755",
  30.         #},
  31.         #{
  32.         #   # The git post-update wrapper.
  33.         #   # Note that this will overwrite any existing
  34.         #   # post-update hook script, which may not be
  35.         #   # what you want.
  36.         #   wrapper => "/git/wiki.git/hooks/post-update",
  37.         #   wrappermode => "06755",
  38.         #},
  39.     ],
  40.     # Default to generating rss feeds for blogs?
  41.     #rss => 1,
  42.     # Default to generating atom feeds for blogs?
  43.     #atom => 1,
  44.     # Allow generating feeds even if not generated by default?
  45.     #allowrss => 1,
  46.     #allowatom => 1,
  47.     # Urls to ping with XML-RPC when rss feeds are updated
  48.     #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  49.     # Include discussion links on all pages?
  50.     discussion => 1,
  51.     # To exclude files matching a regexp from processing. This adds to
  52.     # the default exclude list.
  53.     #exclude => qr/*\.wav/,
  54.     # To change the extension used for generated html files.
  55.     #htmlext => 'htm',
  56.     # Time format (for strftime)
  57.     #timeformat => '%c',
  58.     # Locale to use. Must be a UTF-8 locale.
  59.     #locale => 'en_US.UTF-8',
  60.     # Only send cookies over SSL connections.
  61.     #sslcookie => 1,
  62.     # Logging settings:
  63.     #verbose => 1,
  64.     syslog => 0,
  65.     # To link to user pages in a subdirectory of the wiki.
  66.     #userdir => "users",
  67.     # To create output files named page.html rather than page/index.html.
  68.     #usedirs => 0,
  69.     # Simple spam prevention: require an account-creation password.
  70.     #account_creation_password => "example",
  71.     # Uncomment to force ikiwiki to run with a particular umask.
  72.     #umask => 022,
  73.     # Default settings for the recentchanges page.
  74.     #recentchangespage => "recentchanges",
  75.     #recentchangesnum => 100,
  76.     # To add plugins, list them here.
  77.     #add_plugins => [qw{goodstuff search wikitext camelcase
  78.     #                   htmltidy fortune sidebar map rst anonok}],
  79.     # If you want to disable any of the default plugins, list them here.
  80.     #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
  81.     # To add a directory to the perl search path, use this.
  82.     #libdir => "/home/me/.ikiwiki/",
  83.     # For use with the tag plugin, make all tags be located under a
  84.     # base page.
  85.     #tagbase => "tag",
  86.     # For use with the search plugin if your estseek.cgi is located
  87.     # somewhere else.
  88.     #estseek => "/usr/lib/estraier/estseek.cgi",
  89.     # For use with the openid plugin, to give an url to a page users
  90.     # can use to signup for an OpenID.
  91.     #openidsignup => "http://myopenid.com/",
  92.     # For use with the mirrorlist plugin, a list of mirrors.
  93.     #mirrorlist => {
  94.     #   mirror1 => "http://hostname1",
  95.     #   mirror2 => "http://hostname2/mirror",
  96.     #},
  97. }