]> sipb.mit.edu Git - ikiwiki.git/blob - doc/ikiwiki.setup
Added a hardlink option in the setup file, useful if the source and dest are on the...
[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         #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/log/tip/[[file]]", # hg serve'd local repository
43         #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
44
45         # Bazaar stuff.
46         #rcs => "bzr",
47         #historyurl => "", 
48         #diffurl => "http://example.com/revision?start_revid=[[r2]]#[[file]]-s", # using loggerhead
49
50         # Monotone stuff
51         #rcs => "monotone",
52         #mtnkey => "web\@machine.company.com",
53         #historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
54         #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
55         # Set if you want the wiki to sync on update and commit.
56         #mtnsync => 0,
57         # The path to your workspace (defaults to the srcdir itself)
58         # e.g. use if your srcdir is a subdirectory of the workspace.
59         #mtnrootdir => "path/to/root/of/workspace",
60
61         wrappers => [
62                 #{
63                 #       # The cgi wrapper.
64                 #       cgi => 1,
65                 #       wrapper => "/var/www/wiki/ikiwiki.cgi",
66                 #       wrappermode => "06755",
67                 #},
68                 #{
69                 #       # The svn post-commit wrapper.
70                 #       # Note that this will overwrite any existing
71                 #       # post-commit hook script, which may not be
72                 #       # what you want.
73                 #       wrapper => "/svn/wikirepo/hooks/post-commit",
74                 #       wrappermode => "04755",
75                 #       # Log to syslog since svn post-commit hooks
76                 #       # hide output and errors.
77                 #       syslog => 1,
78                 #},
79                 #{
80                 #       # The git post-update wrapper.
81                 #       # Note that this will overwrite any existing
82                 #       # post-update hook script, which may not be
83                 #       # what you want.
84                 #       wrapper => "/git/wiki.git/hooks/post-update",
85                 #       wrappermode => "06755",
86                 #},
87                 #{
88                 #       # The monotone netsync hook.
89                 #       wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
90                 #       wrappermode => "06755",
91                 #},
92         ],
93
94         # Default to generating rss feeds for blogs?
95         #rss => 1,
96         # Default to generating atom feeds for blogs?
97         #atom => 1,
98         # Allow generating feeds even if not generated by default?
99         #allowrss => 1,
100         #allowatom => 1,
101         # Urls to ping with XML-RPC when rss feeds are updated
102         #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
103         # Include discussion links on all pages?
104         discussion => 1,
105         # To exclude files matching a regexp from processing. This adds to
106         # the default exclude list.
107         #exclude => qr/\.wav$/,
108         # To change the extension used for generated html files.
109         #htmlext => 'htm',
110         # Time format (for strftime)
111         #timeformat => '%c',
112         # Locale to use. Must be a UTF-8 locale.
113         #locale => 'en_US.UTF-8',
114         # Only send cookies over SSL connections.
115         #sslcookie => 1,
116         # Logging settings:
117         #verbose => 1,
118         syslog => 0,
119         # To link to user pages in a subdirectory of the wiki.
120         #userdir => "users",
121         # To create output files named page.html rather than page/index.html.
122         #usedirs => 0,
123         # Simple spam prevention: require an account-creation password.
124         #account_creation_password => "example",
125         # Uncomment to force ikiwiki to run with a particular umask.
126         #umask => 022,
127         # Default settings for the recentchanges page.
128         #recentchangespage => "recentchanges",
129         #recentchangesnum => 100,
130         # Use new '!'-prefixed preprocessor directive syntax
131         #prefix_directives => 0,
132         # Attempt to make hardlinks to source files instead of copying them.
133         # Useful if the wiki contains large media files.
134         #hardlink => 1,
135
136         # To add plugins, list them here.
137         #add_plugins => [qw{goodstuff search wikitext camelcase
138         #                   htmltidy fortune sidebar map rst anonok}],
139         # If you want to disable any of the default plugins, list them here.
140         #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
141         # To add a directory to the perl search path, use this.
142         #libdir => "/home/me/.ikiwiki/",
143
144         # For use with the tag plugin, make all tags be located under a
145         # base page.
146         #tagbase => "tag",
147
148         # For use with the search plugin if your estseek.cgi is located
149         # somewhere else.
150         #estseek => "/usr/lib/estraier/estseek.cgi",
151
152         # For use with the openid plugin, to give an url to a page users
153         # can use to signup for an OpenID.
154         #openidsignup => "http://myopenid.com/",
155
156         # For use with the mirrorlist plugin, a list of mirrors.
157         #mirrorlist => {
158         #       mirror1 => "http://hostname1",
159         #       mirror2 => "http://hostname2/mirror",
160         #},
161 }