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