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