summaryrefslogtreecommitdiff
path: root/ikiwiki.setup
blob: fe8482380a59c7176a526dc67cfc129a7df4bcb4 (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/examplewiki/content",
  13. destdir => $ENV{'HOME'} . "/public_websites/wiki.example.org/wiki",
  14. url => "http://wiki.example.org",
  15. cgiurl => "http://wiki.example.org/ikiwiki.cgi",
  16. templatedir => $ENV{'HOME'} . "/private_webdata/samplewiki/templates",
  17. underlaydir => $ENV{'HOME'} . "/private_webdata/samplewiki/basewiki",
  18. # Git stuff.
  19. #rcs => "git",
  20. #historyurl => "http://git.example.org/?p=samplewiki_content.git;a=history;f=[[file]]", # ;hb=master
  21. #diffurl => "http://git.example.org/?p=samplewiki_content.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  22. #gitorigin_branch => "samplewiki",
  23. #gitmaster_branch => "master",
  24. wrappers => [
  25. #{
  26. # # The cgi wrapper.
  27. # cgi => 1,
  28. # wrapper => $ENV{'HOME'} . "/public_cgi/wiki.example.org/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 => $ENV{'HOME'} . "/public_websites/git.example.org/samplewiki_content.git/hooks/post-update-ikiwiki",
  37. # wrappermode => "06755",
  38. #},
  39. ],
  40. # Default to generating rss feeds for pages with feeds?
  41. #rss => 1,
  42. # Default to generating atom feeds for pages with feeds?
  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 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. # Cost of generating a password using Authen::Passphrase::BlowfishCrypt
  72. #password_cost => 8,
  73. # Uncomment to force ikiwiki to run with a particular umask.
  74. #umask => 022,
  75. # Default settings for the recentchanges page.
  76. #recentchangespage => "recentchanges",
  77. #recentchangesnum => 100,
  78. # Use new '!'-prefixed preprocessor directive syntax
  79. #prefix_directives => 1,
  80. # Attempt to make hardlinks to source files instead of copying them.
  81. # Useful if the wiki contains large media files.
  82. #hardlink => 1,
  83. # Enable use of multimarkdown features in .mdwn files.
  84. #multimarkdown => 1,
  85. # To add plugins, list them here.
  86. #add_plugins => [qw{goodstuff search wikitext camelcase
  87. # htmltidy fortune sidebar map rst anonok}],
  88. # If you want to disable any of the default plugins, list them here.
  89. #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
  90. # To add a directory to the perl search path, use this.
  91. #libdir => "/home/me/private_webdata/samplewiki/perl",
  92. # To override environment variable settings, you can list values here.
  93. #ENV => {
  94. # TZ => "America/New_York",
  95. # PATH => "/home/me/bin:/usr/local/bin:/usr/bin:/bin",
  96. #},
  97. # For use with the tag plugin, make all tags be located under a
  98. # base page.
  99. #tagbase => "tag",
  100. # For use with the search plugin if the omega cgi is located
  101. # somewhere else.
  102. #omega_cgi => "/usr/lib/cgi-bin/omega/omega",
  103. # For use with the openid plugin, to give an url to a page users
  104. # can use to signup for an OpenID.
  105. #openidsignup => "http://myopenid.com/",
  106. # For use with the mirrorlist plugin, a list of mirrors.
  107. #mirrorlist => {
  108. # mirror1 => "http://hostname1",
  109. # mirror2 => "http://hostname2/mirror",
  110. #},
  111. # For use with the anonok plugin, a PageSpec specifying what
  112. # pages anonymous users can edit
  113. #anonok_pagespec => "*",
  114. # For use with the aggregate plugin.
  115. # Enable aggregation to internal pages. New wikis should set this to 1,
  116. # but if you use aggregate already, read the aggregate plugin docs
  117. # before enabling it.
  118. #aggregateinternal => 1,
  119. # Allow aggregation to be triggered via the web.
  120. #aggregate_webtrigger => 1,
  121. # For use with the pinger plugin, how many seconds to wait before
  122. # timing out.
  123. #pinger_timeout => 15.
  124. # For use with the amazon S3 plugin, your public access key id.
  125. #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
  126. # And a file holding your secret key. This file *must* not be
  127. # readable by others!
  128. #amazon_s3_key_file => "/home/me/secret_webdata/s3_key
  129. # The globally unique name of the bucket to use to store the wiki.
  130. #amazon_s3_bucket => "mywiki",
  131. # A prefix to prepend to each page name.
  132. #amazon_s3_prefix => "wiki/",
  133. # Uncomment to use the S3 European datacenter.
  134. #amazon_s3_location => "EU",
  135. # Uncomment if you need to store each index file twice.
  136. #amazon_s3_dupindex => 1,
  137. # For use with the attachment plugin, a program that returns
  138. # nonzero if its standard input contains an virus.
  139. #virus_checker => "clamdscan -",
  140. }