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