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