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