summaryrefslogtreecommitdiff
path: root/ikiwiki.setup
blob: 650487649ae7e5d88a2a71f9eb8fbd5d2b99701c (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. our ($basedir, $builddir, $domain, $gitrepo);
  9. BEGIN {
  10. # git hook requires full path as basedir: $ENV{'HOME'} . '/mywiki'
  11. $basedir = $ENV{'SRCDIR'} || $ENV{'PWD'};
  12. $builddir = $ENV{'BUILDDIR'} || $basedir . '/build';
  13. $domain = 'example.org';
  14. $gitrepo = 'wiki';
  15. }
  16. use IkiWiki::Setup::Standard {
  17. # name of the wiki
  18. wikiname => 'MyWiki',
  19. # contact email for wiki
  20. #adminemail => 'me@' . $domain,
  21. # users who are wiki admins
  22. adminuser => [],
  23. # users who are banned from the wiki
  24. banned_users => [],
  25. # where the source of the wiki is located
  26. srcdir => $basedir . '/content_dummy',
  27. # where to build the wiki
  28. destdir => $builddir . '/html',
  29. # base url to the wiki
  30. url => 'http://wiki.' . $domain . '/',
  31. # url to the ikiwiki.cgi
  32. cgiurl => 'http://wiki.' . $domain . '/ikiwiki.cgi',
  33. # cgi wrapper to generate
  34. cgi_wrapper => $builddir . '/cgi/ikiwiki.cgi',
  35. # mode for cgi_wrapper (can safely be made suid)
  36. cgi_wrappermode => '00755',
  37. # rcs backend to use
  38. rcs => 'git',
  39. # plugins to add to the default configuration
  40. add_plugins => [qw{
  41. h1title
  42. }],
  43. # plugins to disable
  44. disable_plugins => [qw{
  45. editpage
  46. }],
  47. # location of template files
  48. templatedir => $basedir . '/templates',
  49. # base wiki source location
  50. underlaydirs => [
  51. $basedir . '/content',
  52. ],
  53. underlaydir => $basedir . '/basewiki',
  54. # display verbose messages when building?
  55. #verbose => 1,
  56. # log to syslog?
  57. #syslog => 1,
  58. # create output files named page/index.html?
  59. usedirs => 1,
  60. # use '!'-prefixed preprocessor directives?
  61. prefix_directives => 1,
  62. # use page/index.mdwn source files
  63. indexpages => 0,
  64. # enable Discussion pages?
  65. discussion => 1,
  66. # only send cookies over SSL connections?
  67. sslcookie => 0,
  68. # extension to use for new pages
  69. default_pageext => 'mdwn',
  70. # extension to use for html files
  71. htmlext => 'html',
  72. # strftime format string to display date
  73. timeformat => '%c',
  74. # UTF-8 locale to use
  75. #locale => 'en_US.UTF-8',
  76. # put user pages below specified page
  77. userdir => '',
  78. # how many backlinks to show before hiding excess (0 to show all)
  79. numbacklinks => 10,
  80. # attempt to hardlink source files? (optimisation for large files)
  81. hardlink => 0,
  82. # force ikiwiki to use a particular umask
  83. #umask => 022,
  84. # extra library and plugin directory
  85. libdir => $basedir . '/perl',
  86. # environment variables
  87. ENV => {},
  88. # regexp of source files to ignore
  89. #exclude => '\\.wav$',
  90. # specifies the characters that are allowed in source filenames
  91. wiki_file_chars => '-[:alnum:]+/.:_',
  92. # allow symlinks in the path leading to the srcdir (potentially insecure)
  93. allow_symlinks_before_srcdir => 0,
  94. # aggregate plugin
  95. # enable aggregation to internal pages?
  96. #aggregateinternal => 0,
  97. # allow aggregation to be triggered via the web?
  98. #aggregate_webtrigger => 0,
  99. # amazon_s3 plugin
  100. # public access key id
  101. #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
  102. # file holding secret key (must not be readable by others!)
  103. #amazon_s3_key_id => 's3_key',
  104. # globally unique name of bucket to store wiki in
  105. #amazon_s3_bucket => 'mywiki',
  106. # a prefix to prepend to each page name
  107. #amazon_s3_prefix => 'wiki/',
  108. # which S3 datacenter to use (leave blank for default)
  109. #amazon_s3_location => 'EU',
  110. # store each index file twice? (allows urls ending in "/index.html" and "/")
  111. #amazon_s3_dupindex => 0,
  112. # anonok plugin
  113. # PageSpec to limit which pages anonymous users can edit
  114. #anonok_pagespec => '*/discussion',
  115. # attachment plugin
  116. # enhanced PageSpec specifying what attachments are allowed
  117. #allowed_attachments => 'virusfree() and mimetype(image/*) and maxsize(50kb)',
  118. # virus checker program (reads STDIN, returns nonzero if virus found)
  119. #virus_checker => 'clamdscan -',
  120. # calendar plugin
  121. # base of the archives hierarchy
  122. #archivebase => 'archives',
  123. # git plugin
  124. # git hook to generate
  125. git_wrapper => $builddir . '/git/post-update-ikiwiki',
  126. # mode for git_wrapper (can safely be made suid)
  127. git_wrappermode => '06755',
  128. # gitweb url to show file history ([[file]] substituted)
  129. #historyurl => 'http://source.' . $domain . '/gitweb.cgi?p=' . $gitrepo . '.git;a=history;f=[[file]]', # ;hb=master
  130. # gitweb url to show a diff ([[sha1_to]], [[sha1_from]], [[sha1_parent]], and [[file]] substituted)
  131. #diffurl => 'http://source.' . $domain . '/gitweb.cgi?p=' . $gitrepo . '.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]',
  132. # where to pull and push changes (set to empty string to disable)
  133. #gitorigin_branch => 'samplewiki',
  134. # branch that the wiki is stored in
  135. #gitmaster_branch => 'master',
  136. # htmlscrubber plugin
  137. # PageSpec specifying pages not to scrub
  138. #htmlscrubber_skip => '!*/Discussion',
  139. # inline plugin
  140. # enable rss feeds by default?
  141. #rss => 0,
  142. # enable atom feeds by default?
  143. #atom => 0,
  144. # allow rss feeds to be used?
  145. #allowrss => 0,
  146. # allow atom feeds to be used?
  147. #allowatom => 0,
  148. # urls to ping (using XML-RPC) on feed update
  149. #pingurl => 'http://rpc.technorati.com/rpc/ping',
  150. # listdirectives plugin
  151. # directory in srcdir that contains directive descriptions
  152. #directive_description_dir => 'ikiwiki/directive',
  153. # lockedit plugin
  154. # PageSpec controlling which pages are locked
  155. #locked_pages => '!*/Discussion',
  156. # mdwn plugin
  157. # enable multimarkdown features?
  158. #multimarkdown => 0,
  159. # mirrorlist plugin
  160. # list of mirrors
  161. #mirrorlist => {},
  162. # openid plugin
  163. # an url where users can signup for an OpenID
  164. #openidsignup => 'http://myopenid.com/',
  165. # passwordauth plugin
  166. # a password that must be entered when signing up for an account
  167. #account_creation_password => 's3cr1t',
  168. # cost of generating a password using Authen::Passphrase::BlowfishCrypt
  169. #password_cost => 8,
  170. # pinger plugin
  171. # how many seconds to try pinging before timing out
  172. #pinger_timeout => 15,
  173. # prettydate plugin
  174. # format to use to display date
  175. #prettydateformat => '%X, %B %o, %Y',
  176. # recentchanges plugin
  177. # name of the recentchanges page
  178. #recentchangespage => 'recentchanges',
  179. # number of changes to track
  180. #recentchangesnum => 100,
  181. # search plugin
  182. # path to the omega cgi program
  183. #omega_cgi => '/usr/lib/cgi-bin/omega/omega',
  184. # tag plugin
  185. # parent page tags are located under
  186. #tagbase => 'tag',
  187. # teximg plugin
  188. # Should teximg use dvipng to render, or dvips and convert?
  189. #teximg_dvipng => '',
  190. # LaTeX prefix for teximg plugin
  191. #teximg_prefix => '\\documentclass{article}
  192. #\\usepackage{amsmath}
  193. #\\usepackage{amsfonts}
  194. #\\usepackage{amssymb}
  195. #\\pagestyle{empty}
  196. #\\begin{document}
  197. #',
  198. # LaTeX postfix for teximg plugin
  199. #teximg_postfix => '\\end{document}',
  200. # typography plugin
  201. # Text::Typography attributes value
  202. #typographyattributes => '3',
  203. # websetup plugin
  204. # list of plugins that cannot be enabled/disabled via the web interface
  205. #websetup_force_plugins => [],
  206. # show unsafe settings, read-only, in web interface?
  207. #websetup_show_unsafe => 1,
  208. # varioki plugin (strings are eval'ed: double-quote actual strings!)
  209. #varioki => {
  210. # 'branding_logo_text' => '"Example Website"',
  211. # 'branding_logo' => '"logo.png"',
  212. # 'branding_logo_tagline' => '"Yet another ikiwiki site!"',
  213. #},
  214. }