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

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index e8048c3b0..f61c582d8 100644
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -1,41 +1,123 @@
 #!/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.
 
-%setup=(
+use IkiWiki::Setup::Standard {
 	wikiname => "MyWiki",
+	#adminuser => ["yourname", ],
+	adminemail => 'me@example.org',
 
 	# Be sure to customise these..
 	srcdir => "/path/to/source",
-	templatedir => "/path/to/templates",
 	destdir => "/var/www/wiki",
 
-	url => "http://myhost/wiki",
-	cgiurl => "http://myhost/ikiwiki.cgi",
-	#historyurl => "http://svn.myhost/trunk/[[]]",
-	
-	# Whether to integrate with svn.
-	svn => 1,
-	svnrepo => "/svn/wiki",
-
-	# The svn wrapper.
-	svnwrapper => {
-		# Note that this will overwrite any exsting post-commit hoo
-		# script, which may not be what you want.
-		wrapper => "$config{svnrepo}/hooks/post-commit",
-		wrappermode => 04755,
-	},
-	
-	# The cgi wrapper.
-	#cgiwrapper => {
-	#	cgi => 1,
-	#	wrapper => "/var/www/wiki/ikiwiki.cgi",
-	#	wrappermode => 06755,
-	#},
+	url => "http://example.org/wiki",
+	cgiurl => "http://example.org/ikiwiki.cgi",
+	#templatedir => "/usr/share/ikiwiki/templates",
+	#underlaydir => "/usr/share/ikiwiki/basewiki",
+
+	# 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]]",
+	#gitorigin_branch => "origin",
+	#gitmaster_branch => "master",
+
+	# 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 post-commit wrapper.
+		#	# Note that this will overwrite any existing
+		#	# post-commit hook script, which may not be
+		#	# what you want.
+		#	wrapper => "/svn/wikirepo/hooks/post-commit",
+		#	wrappermode => "04755",
+		#	# Enable mail notifications of commits.
+		#	notify => 1,
+		#},
+		#{
+		#	# 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 blogs?
+	rss => 1,
+	# 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 link to user pages in a subdirectory of the wiki.
+	#userdir => "users",
+	# To create output files named page/index.html rather than page.html.
+	#usedirs => 1,
+
+	# To add plugins, list them here.
+	#add_plugins => [qw{goodstuff openid search wikitext camelcase
+	#                   htmltidy fortune sidebar map rst anonok}],
+	# 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/",
+
+	# For use with the mirrorlist plugin, a list of mirrors.
+	#mirrorlist => {
+	#	mirror1 => "http://hostname1",
+	#	mirror2 => "http://hostname2/mirror",
+	#},
+}