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