X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/eff0e7aa8a8e0768b14e6bb45c6c6f1ec75b4ab7..8d9ec24232ede981face0c3eafbce71b74c4725a:/doc/ikiwiki.setup diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup index 9c94bcbe1..6d327fd98 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. @@ -57,12 +58,6 @@ use IkiWiki::Setup::Standard { # 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,14 +92,14 @@ 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, @@ -128,6 +123,8 @@ use IkiWiki::Setup::Standard { #usedirs => 0, # Simple spam prevention: require an account-creation password. #account_creation_password => "example", + # Cost of generating a password using Authen::Passphrase::BlowfishCrypt + #password_cost => 8, # Uncomment to force ikiwiki to run with a particular umask. #umask => 022, # Default settings for the recentchanges page. @@ -135,6 +132,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,14 +145,20 @@ 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. #tagbase => "tag", - # For use with the search plugin if your estseek.cgi is located + # For use with the search plugin if the omega cgi is located # somewhere else. - #estseek => "/usr/lib/estraier/estseek.cgi", + #omega_cgi => "/usr/lib/cgi-bin/omega/omega", # For use with the openid plugin, to give an url to a page users # can use to signup for an OpenID. @@ -161,4 +169,34 @@ 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, + + # For use with the attachment plugin, a program that returns + # nonzero if its standard input contains an virus. + #virus_checker => "clamdscan -", }