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