X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/ee8d0c03133299e4b4f5d0de0f900b96069e400e..3e593eb9c0edd3f5cce7381ca145c0889441d719:/doc/ikiwiki.setup

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 87a19aefc..c6aa08ddd 100644
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -1,57 +1,113 @@
 #!/usr/bin/perl
 # Configuration file for ikiwiki.
-# Passing this to ikiwiki --setup will make ikiwiki generate two
-# wrapper programs, one for cgi and one for a subversion post-commit hook.
+# Passing this to ikiwiki --setup will make ikiwiki generate wrappers and 
+# build the wiki.
 #
 # Remember to re-run ikiwiki --setup any time you edit this file.
 
 use IkiWiki::Setup::Standard {
 	wikiname => "MyWiki",
 	#adminuser => ["yourname", ],
-	adminemail => 'me@myhost',
+	adminemail => 'me@example.org',
 	
 	# Be sure to customise these..
 	srcdir => "/path/to/source",
 	destdir => "/var/www/wiki",
 	
-	url => "http://myhost/wiki",
-	cgiurl => "http://myhost/ikiwiki.cgi",
-	#historyurl => "http://svn.myhost/trunk/[[file]]",
-	#diffurl => "http://svn.someurl/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
+	url => "http://example.org/wiki",
+	cgiurl => "http://example.org/ikiwiki.cgi",
 	#templatedir => "/usr/share/ikiwiki/templates",
 	
-	# Whether to integrate with svn.
-	svn => 1,
+	# Subversion stuff.
+	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.
+	#rcs => "git",
+	#historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
+	#diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
+
+	# Tla stuff.
+	#rcs => "tla"
+	#historyurl => ??,
+	#diffurl => ??,
+
+	# Mercurial stuff.
+	#rcs => "mercurial",
+	#historyurl => "http://localhost:8000/", # hg serve'd local repository
+	#diffurl => "http://localhost:8000/?fd=[[changeset]];file=[[file]]",
+
 	wrappers => [
+		#{
+		#	# The cgi wrapper.
+		#	cgi => 1,
+		#	wrapper => "/var/www/wiki/ikiwiki.cgi",
+		#	wrappermode => "06755",
+		#},
 		{
-			# The svn wrapper.
-			# Note that this will overwrite any exsting
+			# The svn post-commit wrapper.
+			# Note that this will overwrite any existing
 			# post-commit hook script, which may not be
 			# what you want.
-			wrapper => "/svn/wiki/hooks/post-commit",
+			wrapper => "/svn/wikirepo/hooks/post-commit",
 			wrappermode => "04755",
 			# Enable mail notifications of commits.
 			notify => 1,
 		},
 		#{
-		#	# The cgi wrapper.
-		#	cgi => 1,
-		#	wrapper => "/var/www/wiki/ikiwiki.cgi",
-		#	wrappermode => "06755",
+		#	# The git post-update wrapper.
+		#	# Note that this will overwrite any existing
+		#	# post-update hook script, which may not be
+		#	# what you want.
+		#	wrapper => "/git/wiki.git/hooks/post-update",
+		#	wrappermode => "04755",
+		#	# Enable mail notifications of commits.
+		#	notify => 1,
 		#},
 	],
 	
 	# Can anonymous web users edit pages?
 	#anonok => 1,
-	# Generate rss feeds for pages?
+	# Generate rss feeds for blogs?
 	rss => 1,
-	# Use the Hyper Estraier search engine?
-	#hyperestraier => 1,
-	# Sanitize html?
-	sanitize => 1,
-	# To change the enabled plugins, edit this list
-	#plugin => [qw{pagecount inline brokenlinks}],
+	# Generate atom feeds for blogs?
+	atom => 1,
+	# Urls to ping with XML-RPC when rss 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/,
+	# Time format (for strftime)
+	#timeformat => '%c',
+	# Locale to use. Must be a UTF-8 locale.
+	#locale => 'en_US.UTF-8',
+	# Only send cookies over SSL connections.
+	#sslcookie => 1,
+	# Logging settings:
+	verbose => 0,
+	syslog => 0,
+	
+	# To add plugins, list them here.
+	#add_plugins => [qw{meta tag pagecount brokenlinks search smiley
+	#                   wikitext camelcase pagestats htmltidy fortune
+	#                   sidebar map rst toc linkmap openid}],
+	# If you want to disable any of the default plugins, list them here.
+	#disable_plugins => [qw{inline htmlscrubber passwordauth}],
+
+	# For use with the tag plugin, make all tags be located under a
+	# base page.
+	#tagbase => "tag".
+	
+	# For use with the search plugin if your estseek.cgi is located 
+	# somewhere else.
+	#estseek => "/usr/lib/estraier/estseek.cgi",
+	
+	# For use with the openid plugin, to give an url to a page users
+	# can use to signup for an OpenID.
+	#openidsignup => "http://myopenid.com/",
 }