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