X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/1c06aed378e579b7396937fdff4e38ea0482ff5b..1e16ab178d3cfa60818b5a64c35357735e985504:/doc/ikiwiki.setup

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 2c9b02071..e1f698d68 100644
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -15,7 +15,7 @@ use IkiWiki::Setup::Standard {
 	destdir => "/var/www/wiki",
 
 	url => "http://example.org/wiki",
-	cgiurl => "http://example.org/ikiwiki.cgi",
+	cgiurl => "http://example.org/wiki/ikiwiki.cgi",
 	#templatedir => "/usr/share/ikiwiki/templates",
 	#underlaydir => "/usr/share/ikiwiki/basewiki",
 
@@ -23,6 +23,7 @@ use IkiWiki::Setup::Standard {
 	#rcs => "svn",
 	#historyurl => "http://svn.example.org/trunk/[[file]]",
 	#diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
+	#svnrepo => "/svn/wiki",
 	#svnpath => "trunk",
 
 	# Git stuff.
@@ -50,19 +51,13 @@ use IkiWiki::Setup::Standard {
 	# Monotone stuff
 	#rcs => "monotone",
 	#mtnkey => "web\@machine.company.com",
-	#historyurl => "http://viewmtn.example.com/",
+	#historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
 	#diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
 	# Set if you want the wiki to sync on update and commit.
 	#mtnsync => 0,
 	# The path to your workspace (defaults to the srcdir itself)
 	# e.g. use if your srcdir is a subdirectory of the workspace.
 	#mtnrootdir => "path/to/root/of/workspace",
-	# This is a monotone lua hook file used by ikiwiki for
-	# inserting conflict markers. By default it will use
-	# mtnrootdir/_MTN/mergerc. This hook will be populated with
-	# default code the first time you use ikiwiki.  You can
-	# change it to alter how conflict markers are inserted.
-	#mtnmergerc => "path/to/mergerc",
 
 	wrappers => [
 		#{
@@ -97,20 +92,20 @@ use IkiWiki::Setup::Standard {
 		#},
 	],
 
-	# Default to generating rss feeds for blogs?
+	# Default to generating rss feeds for pages with feeds?
 	#rss => 1,
-	# Default to generating atom feeds for blogs?
+	# Default to generating atom feeds for pages with feeds?
 	#atom => 1,
 	# Allow generating feeds even if not generated by default?
 	#allowrss => 1,
 	#allowatom => 1,
-	# Urls to ping with XML-RPC when rss feeds are updated
+	# Urls to ping with XML-RPC when feeds are updated
 	#pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
 	# Include discussion links on all pages?
 	discussion => 1,
 	# To exclude files matching a regexp from processing. This adds to
 	# the default exclude list.
-	#exclude => qr/*\.wav/,
+	#exclude => qr/\.wav$/,
 	# To change the extension used for generated html files.
 	#htmlext => 'htm',
 	# Time format (for strftime)
@@ -135,6 +130,11 @@ use IkiWiki::Setup::Standard {
 	#recentchangesnum => 100,
 	# Use new '!'-prefixed preprocessor directive syntax
 	#prefix_directives => 0,
+	# Attempt to make hardlinks to source files instead of copying them.
+	# Useful if the wiki contains large media files.
+	#hardlink => 1,
+	# Enable use of multimarkdown features in .mdwn files.
+	#multimarkdown => 1,
 
 	# To add plugins, list them here.
 	#add_plugins => [qw{goodstuff search wikitext camelcase
@@ -143,6 +143,12 @@ use IkiWiki::Setup::Standard {
 	#disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
 	# To add a directory to the perl search path, use this.
 	#libdir => "/home/me/.ikiwiki/",
+	
+	# To override environment variable settings, you can list values here.
+	#ENV => {
+	#	TZ => "America/New_York",
+	#	PATH => "/home/me/bin:/usr/local/bin:/usr/bin:/bin",
+	#},
 
 	# For use with the tag plugin, make all tags be located under a
 	# base page.
@@ -161,4 +167,30 @@ use IkiWiki::Setup::Standard {
 	#	mirror1 => "http://hostname1",
 	#	mirror2 => "http://hostname2/mirror",
 	#},
+	
+	# For use with the anonok plugin, a PageSpec specifying what
+	# pages anonymous users can edit
+	#anonok_pagespec => "*",
+	
+	# For use with the aggregate plugin, to allow aggregation to be
+	# triggered via the web.
+	#aggregate_webtrigger => 1,
+	
+	# For use with the pinger plugin, how many seconds to wait before
+	# timing out.
+	#pinger_timeout => 15.
+	
+	# For use with the amazon S3 plugin, your public access key id.
+	#amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
+	# And a file holding your secret key. This file *must* not be
+	# readable by others!
+	#amazon_s3_key_file => "/home/me/.hide/.s3_key
+	# The globally unique name of the bucket to use to store the wiki.
+	#amazon_s3_bucket => "mywiki",
+	# A prefix to prepend to each page name.
+	#amazon_s3_prefix => "wiki/",
+	# Uncomment to use the S3 European datacenter.
+	#amazon_s3_location => "EU",
+	# Uncomment if you need to store each index file twice.
+	#amazon_s3_dupindex => 1,
 }