summaryrefslogtreecommitdiff
path: root/doc/ikiwiki.setup
blob: e1f698d68f77ebe747aaeda2019adc1e2397333c (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/wiki/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/log/tip/[[file]]", # hg serve'd local repository
  37. #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
  38. # Bazaar stuff.
  39. #rcs => "bzr",
  40. #historyurl => "",
  41. #diffurl => "http://example.com/revision?start_revid=[[r2]]#[[file]]-s", # using loggerhead
  42. # Monotone stuff
  43. #rcs => "monotone",
  44. #mtnkey => "web\@machine.company.com",
  45. #historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
  46. #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
  47. # Set if you want the wiki to sync on update and commit.
  48. #mtnsync => 0,
  49. # The path to your workspace (defaults to the srcdir itself)
  50. # e.g. use if your srcdir is a subdirectory of the workspace.
  51. #mtnrootdir => "path/to/root/of/workspace",
  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. # # Log to syslog since svn post-commit hooks
  67. # # hide output and errors.
  68. # syslog => 1,
  69. #},
  70. #{
  71. # # The git post-update wrapper.
  72. # # Note that this will overwrite any existing
  73. # # post-update hook script, which may not be
  74. # # what you want.
  75. # wrapper => "/git/wiki.git/hooks/post-update",
  76. # wrappermode => "06755",
  77. #},
  78. #{
  79. # # The monotone netsync hook.
  80. # wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
  81. # wrappermode => "06755",
  82. #},
  83. ],
  84. # Default to generating rss feeds for pages with feeds?
  85. #rss => 1,
  86. # Default to generating atom feeds for pages with feeds?
  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 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. # Use new '!'-prefixed preprocessor directive syntax
  121. #prefix_directives => 0,
  122. # Attempt to make hardlinks to source files instead of copying them.
  123. # Useful if the wiki contains large media files.
  124. #hardlink => 1,
  125. # Enable use of multimarkdown features in .mdwn files.
  126. #multimarkdown => 1,
  127. # To add plugins, list them here.
  128. #add_plugins => [qw{goodstuff search wikitext camelcase
  129. # htmltidy fortune sidebar map rst anonok}],
  130. # If you want to disable any of the default plugins, list them here.
  131. #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
  132. # To add a directory to the perl search path, use this.
  133. #libdir => "/home/me/.ikiwiki/",
  134. # To override environment variable settings, you can list values here.
  135. #ENV => {
  136. # TZ => "America/New_York",
  137. # PATH => "/home/me/bin:/usr/local/bin:/usr/bin:/bin",
  138. #},
  139. # For use with the tag plugin, make all tags be located under a
  140. # base page.
  141. #tagbase => "tag",
  142. # For use with the search plugin if your estseek.cgi is located
  143. # somewhere else.
  144. #estseek => "/usr/lib/estraier/estseek.cgi",
  145. # For use with the openid plugin, to give an url to a page users
  146. # can use to signup for an OpenID.
  147. #openidsignup => "http://myopenid.com/",
  148. # For use with the mirrorlist plugin, a list of mirrors.
  149. #mirrorlist => {
  150. # mirror1 => "http://hostname1",
  151. # mirror2 => "http://hostname2/mirror",
  152. #},
  153. # For use with the anonok plugin, a PageSpec specifying what
  154. # pages anonymous users can edit
  155. #anonok_pagespec => "*",
  156. # For use with the aggregate plugin, to allow aggregation to be
  157. # triggered via the web.
  158. #aggregate_webtrigger => 1,
  159. # For use with the pinger plugin, how many seconds to wait before
  160. # timing out.
  161. #pinger_timeout => 15.
  162. # For use with the amazon S3 plugin, your public access key id.
  163. #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
  164. # And a file holding your secret key. This file *must* not be
  165. # readable by others!
  166. #amazon_s3_key_file => "/home/me/.hide/.s3_key
  167. # The globally unique name of the bucket to use to store the wiki.
  168. #amazon_s3_bucket => "mywiki",
  169. # A prefix to prepend to each page name.
  170. #amazon_s3_prefix => "wiki/",
  171. # Uncomment to use the S3 European datacenter.
  172. #amazon_s3_location => "EU",
  173. # Uncomment if you need to store each index file twice.
  174. #amazon_s3_dupindex => 1,
  175. }