* Add support for mercurial, contributed by Emanuele Aina.
[ikiwiki.git] / doc / ikiwiki.setup
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
8 use IkiWiki::Setup::Standard {
9         wikiname => "MyWiki",
10         #adminuser => ["yourname", ],
11         adminemail => 'me@myhost',
12         
13         # Be sure to customise these..
14         srcdir => "/path/to/source",
15         destdir => "/var/www/wiki",
16         
17         url => "http://myhost/wiki",
18         cgiurl => "http://myhost/ikiwiki.cgi",
19         #templatedir => "/usr/share/ikiwiki/templates",
20         
21         # Subversion stuff.
22         rcs => "svn",
23         #historyurl => "http://svn.myhost/trunk/[[file]]",
24         #diffurl => "http://svn.someurl/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
25         svnrepo => "/svn/wiki",
26         svnpath => "trunk",
27
28         # Git stuff.
29         #rcs => "git",
30         #historyurl => "http://git.host/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
31         #diffurl => "http://git.host/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
32
33         # Tla stuff.
34         #rcs => "tla"
35         #historyurl => ??,
36         #diffurl => ??,
37
38         # Mercurial stuff.
39         #rcs => "mercurial",
40         #historyurl => "http://localhost:8000/", # hg serve'd local repository
41         #diffurl => "http://localhost:8000/?fd=[[changeset]];file=[[file]]",
42
43         wrappers => [
44                 #{
45                 #       # The cgi wrapper.
46                 #       cgi => 1,
47                 #       wrapper => "/var/www/wiki/ikiwiki.cgi",
48                 #       wrappermode => "06755",
49                 #},
50                 {
51                         # The svn post-commit wrapper.
52                         # Note that this will overwrite any existing
53                         # post-commit hook script, which may not be
54                         # what you want.
55                         wrapper => "/svn/wikirepo/hooks/post-commit",
56                         wrappermode => "04755",
57                         # Enable mail notifications of commits.
58                         notify => 1,
59                 },
60                 #{
61                 #       # The git post-update wrapper.
62                 #       # Note that this will overwrite any existing
63                 #       # post-update hook script, which may not be
64                 #       # what you want.
65                 #       wrapper => "/git/wikirepo/.git/hooks/post-update",
66                 #       wrappermode => "04755",
67                 #       # Enable mail notifications of commits.
68                 #       notify => 1,
69                 #},
70         ],
71         
72         # Can anonymous web users edit pages?
73         #anonok => 1,
74         # Generate rss feeds for pages?
75         rss => 1,
76         # Urls to ping with XML-RPC when rss feeds are updated
77         #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
78         # Include discussion links on all pages?
79         discussion => 1,
80         # To exclude files matching a regexp from processing. This adds to
81         # the default exclude list.
82         #exclude => qr/\*.wav/,
83         # Time format (for strftime)
84         #timeformat => '%c',
85         # Locale to use. Must be a UTF-8 locale.
86         #locale => 'en_US.UTF-8',
87         # Only send cookies over SSL connections.
88         #sslcookie => 1,
89         # Logging settings:
90         verbose => 0,
91         syslog => 0,
92         
93         # To add plugins, list them here.
94         #add_plugins => [qw{meta tag pagecount brokenlinks search smiley
95         #                   wikitext camelcase pagestats htmltidy fortune
96         #                   sidebar map rst toc}],
97         # If you want to disable any of the default plugins, list them here.
98         #disable_plugins => [qw{inline htmlscrubber}],
99 }