summaryrefslogtreecommitdiff
path: root/doc/ikiwiki.setup
blob: f61c582d8c2de04de2414896a89ba68e9737767e (plain)
  1. #!/usr/bin/perl
  2. # Configuration file for ikiwiki.
  3. # Passing this to ikiwiki --setup will make ikiwiki generate wrappers and
  4. # build the wiki.
  5. #
  6. # Remember to re-run ikiwiki --setup any time you edit this file.
  7. use IkiWiki::Setup::Standard {
  8. wikiname => "MyWiki",
  9. #adminuser => ["yourname", ],
  10. adminemail => 'me@example.org',
  11. # Be sure to customise these..
  12. srcdir => "/path/to/source",
  13. destdir => "/var/www/wiki",
  14. url => "http://example.org/wiki",
  15. cgiurl => "http://example.org/ikiwiki.cgi",
  16. #templatedir => "/usr/share/ikiwiki/templates",
  17. #underlaydir => "/usr/share/ikiwiki/basewiki",
  18. # Subversion stuff.
  19. #rcs => "svn",
  20. #historyurl => "http://svn.example.org/trunk/[[file]]",
  21. #diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
  22. #svnrepo => "/svn/wiki",
  23. #svnpath => "trunk",
  24. # Git stuff.
  25. #rcs => "git",
  26. #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
  27. #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  28. #gitorigin_branch => "origin",
  29. #gitmaster_branch => "master",
  30. # Tla stuff.
  31. #rcs => "tla"
  32. #historyurl => ??,
  33. #diffurl => ??,
  34. # Mercurial stuff.
  35. #rcs => "mercurial",
  36. #historyurl => "http://localhost:8000/", # hg serve'd local repository
  37. #diffurl => "http://localhost:8000/?fd=[[changeset]];file=[[file]]",
  38. wrappers => [
  39. #{
  40. # # The cgi wrapper.
  41. # cgi => 1,
  42. # wrapper => "/var/www/wiki/ikiwiki.cgi",
  43. # wrappermode => "06755",
  44. #},
  45. #{
  46. # # The svn post-commit wrapper.
  47. # # Note that this will overwrite any existing
  48. # # post-commit hook script, which may not be
  49. # # what you want.
  50. # wrapper => "/svn/wikirepo/hooks/post-commit",
  51. # wrappermode => "04755",
  52. # # Enable mail notifications of commits.
  53. # notify => 1,
  54. #},
  55. #{
  56. # # The git post-update wrapper.
  57. # # Note that this will overwrite any existing
  58. # # post-update hook script, which may not be
  59. # # what you want.
  60. # wrapper => "/git/wiki.git/hooks/post-update",
  61. # wrappermode => "04755",
  62. # # Enable mail notifications of commits.
  63. # notify => 1,
  64. #},
  65. ],
  66. # Generate rss feeds for blogs?
  67. rss => 1,
  68. # Generate atom feeds for blogs?
  69. atom => 1,
  70. # Urls to ping with XML-RPC when rss feeds are updated
  71. #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  72. # Include discussion links on all pages?
  73. discussion => 1,
  74. # To exclude files matching a regexp from processing. This adds to
  75. # the default exclude list.
  76. #exclude => qr/*\.wav/,
  77. # Time format (for strftime)
  78. #timeformat => '%c',
  79. # Locale to use. Must be a UTF-8 locale.
  80. #locale => 'en_US.UTF-8',
  81. # Only send cookies over SSL connections.
  82. #sslcookie => 1,
  83. # Logging settings:
  84. verbose => 0,
  85. syslog => 0,
  86. # To link to user pages in a subdirectory of the wiki.
  87. #userdir => "users",
  88. # To create output files named page/index.html rather than page.html.
  89. #usedirs => 1,
  90. # To add plugins, list them here.
  91. #add_plugins => [qw{goodstuff openid search wikitext camelcase
  92. # htmltidy fortune sidebar map rst anonok}],
  93. # If you want to disable any of the default plugins, list them here.
  94. #disable_plugins => [qw{inline htmlscrubber passwordauth}],
  95. # For use with the tag plugin, make all tags be located under a
  96. # base page.
  97. #tagbase => "tag",
  98. # For use with the search plugin if your estseek.cgi is located
  99. # somewhere else.
  100. #estseek => "/usr/lib/estraier/estseek.cgi",
  101. # For use with the openid plugin, to give an url to a page users
  102. # can use to signup for an OpenID.
  103. #openidsignup => "http://myopenid.com/",
  104. # For use with the mirrorlist plugin, a list of mirrors.
  105. #mirrorlist => {
  106. # mirror1 => "http://hostname1",
  107. # mirror2 => "http://hostname2/mirror",
  108. #},
  109. }