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