summaryrefslogtreecommitdiff
path: root/ikiwiki.setup
blob: afe0e87709bb839fe8e5c294cf0cd8b80c6624ef (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 => $ENV{'HOME'} . "/private_webdata/samplewiki/content_dummy",
  13. destdir => $ENV{'HOME'} . "/public_websites/wiki.example.org",
  14. url => "http://wiki.example.org",
  15. cgiurl => "http://wiki.example.org/ikiwiki.cgi",
  16. templatedir => $ENV{'HOME'} . "/private_webdata/samplewiki/templates_nonedit",
  17. underlaydirs => [
  18. $ENV{'HOME'} . "/private_webdata/samplewiki/content",
  19. ],
  20. underlaydir => $ENV{'HOME'} . "/private_webdata/samplewiki/basewiki_nonedit",
  21. # Subversion stuff.
  22. #rcs => "svn",
  23. #historyurl => "http://svn.example.org/trunk/[[file]]",
  24. #diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
  25. #svnrepo => "/svn/wiki",
  26. #svnpath => "trunk",
  27. # Git stuff.
  28. #rcs => "git",
  29. #historyurl => "http://git.example.org/?p=samplewiki_content.git;a=history;f=[[file]]", # ;hb=master
  30. #diffurl => "http://git.example.org/?p=samplewiki_content.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  31. #gitorigin_branch => "samplewiki",
  32. #gitmaster_branch => "master",
  33. # Tla stuff.
  34. #rcs => "tla"
  35. #historyurl => ??,
  36. #diffurl => ??,
  37. # Mercurial stuff.
  38. #rcs => "mercurial",
  39. #historyurl => "http://localhost:8000/log/tip/[[file]]", # hg serve'd local repository
  40. #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
  41. # Bazaar stuff.
  42. #rcs => "bzr",
  43. #historyurl => "",
  44. #diffurl => "http://example.com/revision?start_revid=[[r2]]#[[file]]-s", # using loggerhead
  45. # Monotone stuff
  46. #rcs => "monotone",
  47. #mtnkey => "web\@machine.company.com",
  48. #historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
  49. #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
  50. # Set if you want the wiki to sync on update and commit.
  51. #mtnsync => 0,
  52. # The path to your workspace (defaults to the srcdir itself)
  53. # e.g. use if your srcdir is a subdirectory of the workspace.
  54. #mtnrootdir => "path/to/root/of/workspace",
  55. wrappers => [
  56. #{
  57. # # The cgi wrapper.
  58. # cgi => 1,
  59. # wrapper => $ENV{'HOME'} . "/public_cgi/wiki.example.org/ikiwiki.cgi",
  60. # wrappermode => "06755",
  61. #},
  62. #{
  63. # # The svn post-commit wrapper.
  64. # # Note that this will overwrite any existing
  65. # # post-commit hook script, which may not be
  66. # # what you want.
  67. # wrapper => "/svn/wikirepo/hooks/post-commit",
  68. # wrappermode => "04755",
  69. # # Log to syslog since svn post-commit hooks
  70. # # hide output and errors.
  71. # syslog => 1,
  72. #},
  73. #{
  74. # # The git post-update wrapper.
  75. # # Note that this will overwrite any existing
  76. # # post-update hook script, which may not be
  77. # # what you want.
  78. # wrapper => $ENV{'HOME'} . "/public_websites/git.example.org/samplewiki_content.git/hooks/post-update-ikiwiki",
  79. # wrappermode => "06755",
  80. #},
  81. #{
  82. # # The monotone netsync hook.
  83. # wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
  84. # wrappermode => "06755",
  85. #},
  86. ],
  87. # Default to generating rss feeds for pages with feeds?
  88. #rss => 1,
  89. # Default to generating atom feeds for pages with feeds?
  90. #atom => 1,
  91. # Allow generating feeds even if not generated by default?
  92. #allowrss => 1,
  93. #allowatom => 1,
  94. # Urls to ping with XML-RPC when feeds are updated
  95. #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  96. # Include discussion links on all pages?
  97. discussion => 1,
  98. # To exclude files matching a regexp from processing. This adds to
  99. # the default exclude list.
  100. #exclude => qr/\.wav$/,
  101. # To change the extension used for generated html files.
  102. #htmlext => 'htm',
  103. # Time format (for strftime)
  104. #timeformat => '%c',
  105. # Locale to use. Must be a UTF-8 locale.
  106. #locale => 'en_US.UTF-8',
  107. # Only send cookies over SSL connections.
  108. #sslcookie => 1,
  109. # Logging settings:
  110. #verbose => 1,
  111. syslog => 0,
  112. # To link to user pages in a subdirectory of the wiki.
  113. #userdir => "users",
  114. # To create output files named page.html rather than page/index.html.
  115. #usedirs => 0,
  116. # Simple spam prevention: require an account-creation password.
  117. #account_creation_password => "example",
  118. # Cost of generating a password using Authen::Passphrase::BlowfishCrypt
  119. #password_cost => 8,
  120. # Uncomment to force ikiwiki to run with a particular umask.
  121. #umask => 022,
  122. # Default settings for the recentchanges page.
  123. #recentchangespage => "recentchanges",
  124. #recentchangesnum => 100,
  125. # Use new '!'-prefixed preprocessor directive syntax
  126. #prefix_directives => 1,
  127. # Attempt to make hardlinks to source files instead of copying them.
  128. # Useful if the wiki contains large media files.
  129. #hardlink => 1,
  130. # Enable use of multimarkdown features in .mdwn files.
  131. #multimarkdown => 1,
  132. # To add plugins, list them here.
  133. #add_plugins => [qw{goodstuff search wikitext camelcase
  134. # htmltidy fortune sidebar map rst anonok}],
  135. # If you want to disable any of the default plugins, list them here.
  136. #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
  137. # To add a directory to the perl search path, use this.
  138. #libdir => "/home/me/private_webdata/samplewiki/perl",
  139. # To override environment variable settings, you can list values here.
  140. #ENV => {
  141. # TZ => "America/New_York",
  142. # PATH => "/home/me/bin:/usr/local/bin:/usr/bin:/bin",
  143. #},
  144. # For use with the tag plugin, make all tags be located under a
  145. # base page.
  146. #tagbase => "tag",
  147. # For use with the search plugin if the omega cgi is located
  148. # somewhere else.
  149. #omega_cgi => "/usr/lib/cgi-bin/omega/omega",
  150. # For use with the openid plugin, to give an url to a page users
  151. # can use to signup for an OpenID.
  152. #openidsignup => "http://myopenid.com/",
  153. # For use with the mirrorlist plugin, a list of mirrors.
  154. #mirrorlist => {
  155. # mirror1 => "http://hostname1",
  156. # mirror2 => "http://hostname2/mirror",
  157. #},
  158. # For use with the anonok plugin, a PageSpec specifying what
  159. # pages anonymous users can edit
  160. #anonok_pagespec => "*",
  161. # For use with the aggregate plugin.
  162. # Enable aggregation to internal pages. New wikis should set this to 1,
  163. # but if you use aggregate already, read the aggregate plugin docs
  164. # before enabling it.
  165. #aggregateinternal => 1,
  166. # Allow aggregation to be triggered via the web.
  167. #aggregate_webtrigger => 1,
  168. # For use with the pinger plugin, how many seconds to wait before
  169. # timing out.
  170. #pinger_timeout => 15.
  171. # For use with the amazon S3 plugin, your public access key id.
  172. #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
  173. # And a file holding your secret key. This file *must* not be
  174. # readable by others!
  175. #amazon_s3_key_file => "/home/me/secret_webdata/s3_key
  176. # The globally unique name of the bucket to use to store the wiki.
  177. #amazon_s3_bucket => "mywiki",
  178. # A prefix to prepend to each page name.
  179. #amazon_s3_prefix => "wiki/",
  180. # Uncomment to use the S3 European datacenter.
  181. #amazon_s3_location => "EU",
  182. # Uncomment if you need to store each index file twice.
  183. #amazon_s3_dupindex => 1,
  184. # For use with the attachment plugin, a program that returns
  185. # nonzero if its standard input contains an virus.
  186. #virus_checker => "clamdscan -",
  187. }