summaryrefslogtreecommitdiff
path: root/ikiwiki.setup
blob: 008a15c8960aab462bb6dffbbfd6104ba00ec0a1 (plain)
  1. #!/usr/bin/perl
  2. # Setup file for ikiwiki.
  3. #
  4. # Passing this to ikiwiki --setup will make ikiwiki generate
  5. # wrappers and build the wiki.
  6. #
  7. # Remember to re-run ikiwiki --setup any time you edit this file.
  8. use IkiWiki::Setup::Standard {
  9. # name of the wiki
  10. wikiname => 'hello!earth',
  11. # contact email for wiki
  12. adminemail => 'webmaster@biks.dk',
  13. # users who are wiki admins
  14. adminuser => [],
  15. # users who are banned from the wiki
  16. banned_users => [],
  17. # where the source of the wiki is located
  18. srcdir => $ENV{'HOME'} . '/private_webdata/hearth/content',
  19. # where to build the wiki
  20. destdir => $ENV{'HOME'} . '/public_websites/helloearth.biks.dk',
  21. # base url to the wiki
  22. url => 'http://helloearth.biks.dk',
  23. # url to the ikiwiki.cgi
  24. cgiurl => 'http://helloearth.biks.dk/ikiwiki.cgi',
  25. # cgi wrapper to generate
  26. cgi_wrapper => $ENV{'HOME'} . '/public_cgi/helloearth.biks.dk/ikiwiki.cgi',
  27. # mode for cgi_wrapper (can safely be made suid)
  28. cgi_wrappermode => '00755',
  29. # rcs backend to use
  30. rcs => 'git',
  31. # plugins to add to the default configuration
  32. add_plugins => [qw{
  33. goodstuff search topbar sidebar favicon pinger
  34. }],
  35. # plugins to disable
  36. disable_plugins => [qw{
  37. passwordauth
  38. }],
  39. # location of template files
  40. templatedir => $ENV{'HOME'} . '/private_webdata/hearth/templates',
  41. # base wiki source location
  42. underlaydir => $ENV{'HOME'} . '/private_webdata/hearth/basewiki',
  43. # display verbose messages when building?
  44. #verbose => 1,
  45. # log to syslog?
  46. #syslog => 1,
  47. # create output files named page/index.html?
  48. usedirs => 1,
  49. # use '!'-prefixed preprocessor directives?
  50. prefix_directives => 1,
  51. # use page/index.mdwn source files
  52. indexpages => 0,
  53. # enable Discussion pages?
  54. discussion => 1,
  55. # only send cookies over SSL connections?
  56. sslcookie => 0,
  57. # extension to use for new pages
  58. default_pageext => 'mdwn',
  59. # extension to use for html files
  60. htmlext => 'html',
  61. # strftime format string to display date
  62. timeformat => '%c',
  63. # UTF-8 locale to use
  64. #locale => 'en_US.UTF-8',
  65. # put user pages below specified page
  66. userdir => '',
  67. # how many backlinks to show before hiding excess (0 to show all)
  68. numbacklinks => 10,
  69. # attempt to hardlink source files? (optimisation for large files)
  70. hardlink => 0,
  71. # force ikiwiki to use a particular umask
  72. #umask => 022,
  73. # extra library and plugin directory
  74. libdir => $ENV{'HOME'} . '/private_webdata/hearth/perl',
  75. # environment variables
  76. ENV => {},
  77. # regexp of source files to ignore
  78. #exclude => '\\.wav$',
  79. # specifies the characters that are allowed in source filenames
  80. wiki_file_chars => '-[:alnum:]+/.:_',
  81. # allow symlinks in the path leading to the srcdir (potentially insecure)
  82. allow_symlinks_before_srcdir => 0,
  83. # aggregate plugin
  84. # enable aggregation to internal pages?
  85. #aggregateinternal => 0,
  86. # allow aggregation to be triggered via the web?
  87. #aggregate_webtrigger => 0,
  88. # anonok plugin
  89. # PageSpec to limit which pages anonymous users can edit
  90. #anonok_pagespec => '*/discussion',
  91. # attachment plugin
  92. # enhanced PageSpec specifying what attachments are allowed
  93. #allowed_attachments => 'virusfree() and mimetype(image/*) and maxsize(50kb)',
  94. # virus checker program (reads STDIN, returns nonzero if virus found)
  95. #virus_checker => 'clamdscan -',
  96. # calendar plugin
  97. # base of the archives hierarchy
  98. #archivebase => 'archives',
  99. # git plugin
  100. # git hook to generate
  101. git_wrapper => $ENV{'HOME'} . '/public_websites/source.jones.dk/hearth_content.git/hooks/post-update-ikiwiki',
  102. # mode for git_wrapper (can safely be made suid)
  103. git_wrappermode => '06755',
  104. # gitweb url to show file history ([[file]] substituted)
  105. historyurl => 'http://source.jones.dk/?p=hearth_content.git;a=history;f=[[file]]', # ;hb=master
  106. # gitweb url to show a diff ([[sha1_to]], [[sha1_from]], [[sha1_parent]], and [[file]] substituted)
  107. diffurl => 'http://source.jones.dk/?p=hearth_content.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]',
  108. # where to pull and push changes (set to empty string to disable)
  109. #gitorigin_branch => 'samplewiki',
  110. # branch that the wiki is stored in
  111. #gitmaster_branch => 'master',
  112. # htmlscrubber plugin
  113. # PageSpec specifying pages not to scrub
  114. #htmlscrubber_skip => '!*/Discussion',
  115. # inline plugin
  116. # enable rss feeds by default?
  117. #rss => 0,
  118. # enable atom feeds by default?
  119. #atom => 0,
  120. # allow rss feeds to be used?
  121. #allowrss => 0,
  122. # allow atom feeds to be used?
  123. #allowatom => 0,
  124. # urls to ping (using XML-RPC) on feed update
  125. #pingurl => 'http://rpc.technorati.com/rpc/ping',
  126. # listdirectives plugin
  127. # directory in srcdir that contains directive descriptions
  128. #directive_description_dir => 'ikiwiki/directive',
  129. # lockedit plugin
  130. # PageSpec controlling which pages are locked
  131. #locked_pages => '!*/Discussion',
  132. # mdwn plugin
  133. # enable multimarkdown features?
  134. #multimarkdown => 0,
  135. # mirrorlist plugin
  136. # list of mirrors
  137. #mirrorlist => {},
  138. # openid plugin
  139. # an url where users can signup for an OpenID
  140. #openidsignup => 'http://myopenid.com/',
  141. # passwordauth plugin
  142. # a password that must be entered when signing up for an account
  143. #account_creation_password => 's3cr1t',
  144. # cost of generating a password using Authen::Passphrase::BlowfishCrypt
  145. #password_cost => 8,
  146. # pinger plugin
  147. # how many seconds to try pinging before timing out
  148. #pinger_timeout => 15,
  149. # prettydate plugin
  150. # format to use to display date
  151. #prettydateformat => '%X, %B %o, %Y',
  152. # recentchanges plugin
  153. # name of the recentchanges page
  154. #recentchangespage => 'recentchanges',
  155. # number of changes to track
  156. #recentchangesnum => 100,
  157. # search plugin
  158. # path to the omega cgi program
  159. #omega_cgi => '/usr/lib/cgi-bin/omega/omega',
  160. # tag plugin
  161. # parent page tags are located under
  162. #tagbase => 'tag',
  163. # typography plugin
  164. # Text::Typography attributes value
  165. #typographyattributes => '3',
  166. }