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