summaryrefslogtreecommitdiff
path: root/doc/ikiwiki.setup
blob: 7d0eb71fe32d5779937a896b7f47a98253edd903 (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. # Subversion stuff.
  18. rcs => "svn",
  19. #historyurl => "http://svn.example.org/trunk/[[file]]",
  20. #diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
  21. svnrepo => "/svn/wiki",
  22. svnpath => "trunk",
  23. # Git stuff.
  24. #rcs => "git",
  25. #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
  26. #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  27. # Tla stuff.
  28. #rcs => "tla"
  29. #historyurl => ??,
  30. #diffurl => ??,
  31. # Mercurial stuff.
  32. #rcs => "mercurial",
  33. #historyurl => "http://localhost:8000/", # hg serve'd local repository
  34. #diffurl => "http://localhost:8000/?fd=[[changeset]];file=[[file]]",
  35. wrappers => [
  36. #{
  37. # # The cgi wrapper.
  38. # cgi => 1,
  39. # wrapper => "/var/www/wiki/ikiwiki.cgi",
  40. # wrappermode => "06755",
  41. #},
  42. {
  43. # The svn post-commit wrapper.
  44. # Note that this will overwrite any existing
  45. # post-commit hook script, which may not be
  46. # what you want.
  47. wrapper => "/svn/wikirepo/hooks/post-commit",
  48. wrappermode => "04755",
  49. # Enable mail notifications of commits.
  50. notify => 1,
  51. },
  52. #{
  53. # # The git post-update wrapper.
  54. # # Note that this will overwrite any existing
  55. # # post-update hook script, which may not be
  56. # # what you want.
  57. # wrapper => "/git/wiki.git/hooks/post-update",
  58. # wrappermode => "04755",
  59. # # Enable mail notifications of commits.
  60. # notify => 1,
  61. #},
  62. ],
  63. # Can anonymous web users edit pages?
  64. #anonok => 1,
  65. # Generate rss feeds for blogs?
  66. rss => 1,
  67. # Generate atom feeds for blogs?
  68. atom => 1,
  69. # Urls to ping with XML-RPC when rss feeds are updated
  70. #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  71. # Include discussion links on all pages?
  72. discussion => 1,
  73. # To exclude files matching a regexp from processing. This adds to
  74. # the default exclude list.
  75. #exclude => qr/\*.wav/,
  76. # Time format (for strftime)
  77. #timeformat => '%c',
  78. # Locale to use. Must be a UTF-8 locale.
  79. #locale => 'en_US.UTF-8',
  80. # Only send cookies over SSL connections.
  81. #sslcookie => 1,
  82. # Logging settings:
  83. verbose => 0,
  84. syslog => 0,
  85. # To add plugins, list them here.
  86. #add_plugins => [qw{meta tag pagecount brokenlinks search smiley
  87. # wikitext camelcase pagestats htmltidy fortune
  88. # sidebar map rst toc linkmap openid}],
  89. # If you want to disable any of the default plugins, list them here.
  90. #disable_plugins => [qw{inline htmlscrubber}],
  91. # For use with the tag plugin, make all tags be located under a
  92. # base page.
  93. #tagbase => "tag".
  94. # For use with the search plugin if your estseek.cgi is located
  95. # somewhere else.
  96. #estseek => "/usr/lib/estraier/estseek.cgi",
  97. # For use with the openid plugin, to give an url to a page users
  98. # can use to signup for an OpenID.
  99. #openidsignup => "http://myopenid.com/",
  100. }