summaryrefslogtreecommitdiff
path: root/doc/ikiwiki.setup
blob: bf1aa3703a41d8d48f1a66a98e849929947d5664 (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@myhost',
  11. # Be sure to customise these..
  12. srcdir => "/path/to/source",
  13. destdir => "/var/www/wiki",
  14. url => "http://myhost/wiki",
  15. cgiurl => "http://myhost/ikiwiki.cgi",
  16. #templatedir => "/usr/share/ikiwiki/templates",
  17. # Subversion stuff.
  18. rcs => "svn",
  19. #historyurl => "http://svn.myhost/trunk/[[file]]",
  20. #diffurl => "http://svn.someurl/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.host/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
  26. #diffurl => "http://git.host/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  27. wrappers => [
  28. #{
  29. # # The cgi wrapper.
  30. # cgi => 1,
  31. # wrapper => "/var/www/wiki/ikiwiki.cgi",
  32. # wrappermode => "06755",
  33. #},
  34. {
  35. # The svn post-commit wrapper.
  36. # Note that this will overwrite any existing
  37. # post-commit hook script, which may not be
  38. # what you want.
  39. wrapper => "/svn/wikirepo/hooks/post-commit",
  40. wrappermode => "04755",
  41. # Enable mail notifications of commits.
  42. notify => 1,
  43. },
  44. #{
  45. # # The git post-update wrapper.
  46. # # Note that this will overwrite any existing
  47. # # post-update hook script, which may not be
  48. # # what you want.
  49. # wrapper => "/git/wikirepo/.git/hooks/post-update",
  50. # wrappermode => "04755",
  51. # # Enable mail notifications of commits.
  52. # notify => 1,
  53. #},
  54. ],
  55. # Can anonymous web users edit pages?
  56. #anonok => 1,
  57. # Generate rss feeds for pages?
  58. rss => 1,
  59. # Urls to ping with XML-RPC when rss feeds are updated
  60. #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  61. # Include discussion links on all pages?
  62. discussion => 1,
  63. # To exclude files matching a regexp from processing. This adds to
  64. # the default exclude list.
  65. #exclude => qr/\*.wav/,
  66. # Time format (for strftime)
  67. #timeformat => '%c',
  68. # Locale to use. Must be a UTF-8 locale.
  69. #locale => 'en_US.UTF-8',
  70. # Logging settings:
  71. verbose => 0,
  72. syslog => 0,
  73. # To add plugins, list them here.
  74. #add_plugins => [qw{meta tag pagecount brokenlinks search smiley
  75. # wikitext camelcase pagestats htmltidy fortune
  76. # sidebar map rst}],
  77. # If you want to disable any of the default plugins, list them here.
  78. #disable_plugins => [qw{inline htmlscrubber}],
  79. }