summaryrefslogtreecommitdiff
path: root/doc/ikiwiki.setup
blob: 039ebb127bb451d0d0783c229c11d82cd5b806c7 (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/branch/head/filechanges/com.example.branch/[[file]]",
  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. wrappers => [
  52. #{
  53. # # The cgi wrapper.
  54. # cgi => 1,
  55. # wrapper => "/var/www/wiki/ikiwiki.cgi",
  56. # wrappermode => "06755",
  57. #},
  58. #{
  59. # # The svn post-commit wrapper.
  60. # # Note that this will overwrite any existing
  61. # # post-commit hook script, which may not be
  62. # # what you want.
  63. # wrapper => "/svn/wikirepo/hooks/post-commit",
  64. # wrappermode => "04755",
  65. # # Log to syslog since svn post-commit hooks
  66. # # hide output and errors.
  67. # syslog => 1,
  68. #},
  69. #{
  70. # # The git post-update wrapper.
  71. # # Note that this will overwrite any existing
  72. # # post-update hook script, which may not be
  73. # # what you want.
  74. # wrapper => "/git/wiki.git/hooks/post-update",
  75. # wrappermode => "06755",
  76. #},
  77. #{
  78. # # The monotone netsync hook.
  79. # wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
  80. # wrappermode => "06755",
  81. #},
  82. ],
  83. # Default to generating rss feeds for pages with feeds?
  84. #rss => 1,
  85. # Default to generating atom feeds for pages with feeds?
  86. #atom => 1,
  87. # Allow generating feeds even if not generated by default?
  88. #allowrss => 1,
  89. #allowatom => 1,
  90. # Urls to ping with XML-RPC when rss feeds are updated
  91. #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  92. # Include discussion links on all pages?
  93. discussion => 1,
  94. # To exclude files matching a regexp from processing. This adds to
  95. # the default exclude list.
  96. #exclude => qr/\.wav$/,
  97. # To change the extension used for generated html files.
  98. #htmlext => 'htm',
  99. # Time format (for strftime)
  100. #timeformat => '%c',
  101. # Locale to use. Must be a UTF-8 locale.
  102. #locale => 'en_US.UTF-8',
  103. # Only send cookies over SSL connections.
  104. #sslcookie => 1,
  105. # Logging settings:
  106. #verbose => 1,
  107. syslog => 0,
  108. # To link to user pages in a subdirectory of the wiki.
  109. #userdir => "users",
  110. # To create output files named page.html rather than page/index.html.
  111. #usedirs => 0,
  112. # Simple spam prevention: require an account-creation password.
  113. #account_creation_password => "example",
  114. # Uncomment to force ikiwiki to run with a particular umask.
  115. #umask => 022,
  116. # Default settings for the recentchanges page.
  117. #recentchangespage => "recentchanges",
  118. #recentchangesnum => 100,
  119. # Use new '!'-prefixed preprocessor directive syntax
  120. #prefix_directives => 0,
  121. # Attempt to make hardlinks to source files instead of copying them.
  122. # Useful if the wiki contains large media files.
  123. #hardlink => 1,
  124. # To add plugins, list them here.
  125. #add_plugins => [qw{goodstuff search wikitext camelcase
  126. # htmltidy fortune sidebar map rst anonok}],
  127. # If you want to disable any of the default plugins, list them here.
  128. #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
  129. # To add a directory to the perl search path, use this.
  130. #libdir => "/home/me/.ikiwiki/",
  131. # For use with the tag plugin, make all tags be located under a
  132. # base page.
  133. #tagbase => "tag",
  134. # For use with the search plugin if your estseek.cgi is located
  135. # somewhere else.
  136. #estseek => "/usr/lib/estraier/estseek.cgi",
  137. # For use with the openid plugin, to give an url to a page users
  138. # can use to signup for an OpenID.
  139. #openidsignup => "http://myopenid.com/",
  140. # For use with the mirrorlist plugin, a list of mirrors.
  141. #mirrorlist => {
  142. # mirror1 => "http://hostname1",
  143. # mirror2 => "http://hostname2/mirror",
  144. #},
  145. }