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