]> sipb.mit.edu Git - ikiwiki.git/blob - doc/ikiwiki.setup
move to more appropriate page
[ikiwiki.git] / doc / ikiwiki.setup
1 #!/usr/bin/perl
2 # Configuration file for ikiwiki.
3 # Passing this to ikiwiki --setup will make ikiwiki generate two
4 # wrapper programs, one for cgi and one for a subversion post-commit hook.
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         wrappers => [
34                 #{
35                 #       # The cgi wrapper.
36                 #       cgi => 1,
37                 #       wrapper => "/var/www/wiki/ikiwiki.cgi",
38                 #       wrappermode => "06755",
39                 #},
40                 {
41                         # The svn post-commit wrapper.
42                         # Note that this will overwrite any existing
43                         # post-commit hook script, which may not be
44                         # what you want.
45                         wrapper => "/svn/wikirepo/hooks/post-commit",
46                         wrappermode => "04755",
47                         # Enable mail notifications of commits.
48                         notify => 1,
49                 },
50                 #{
51                 #       # The git post-update wrapper.
52                 #       # Note that this will overwrite any existing
53                 #       # post-update hook script, which may not be
54                 #       # what you want.
55                 #       wrapper => "/git/wikirepo/hooks/post-update",
56                 #       wrappermode => "04755",
57                 #       # Enable mail notifications of commits.
58                 #       notify => 1,
59                 #},
60         ],
61         
62         # Can anonymous web users edit pages?
63         #anonok => 1,
64         # Generate rss feeds for pages?
65         rss => 1,
66         # Include discussion links on all pages?
67         discussion => 1,
68         # Time format (for strftime)
69         #timeformat => '%c',
70         # To change the enabled plugins, edit this list
71         #plugin => [qw{pagecount inline brokenlinks search smiley
72         #              htmlscrubber}],
73 }