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