Updated setup for new upstream
authorTuomas Jormola <tj@solitudo.net>
Thu, 30 Jan 2014 12:32:32 +0000 (14:32 +0200)
committerTuomas Jormola <tj@solitudo.net>
Thu, 30 Jan 2014 12:32:32 +0000 (14:32 +0200)
ikiwiki.setup

index e930edf..3522b43 100644 (file)
@@ -28,6 +28,12 @@ use IkiWiki::Setup::Standard {
        cgi_wrapper => -x '/usr/bin/cc' ? $ENV{IKIWIKI_HTDOCS} . '/ikiwiki.cgi' : '',
        # mode for cgi_wrapper (can safely be made suid)
        cgi_wrappermode => '06755',
+       # number of seconds to delay CGI requests when overloaded
+       cgi_overload_delay => '',
+       # message to display when overloaded (may contain html)
+       cgi_overload_message => '',
+       # enable optimization of only refreshing committed changes?
+       only_committed_changes => 0,
        # rcs backend to use
        rcs => 'git',
        gettime => 1,
@@ -53,7 +59,7 @@ use IkiWiki::Setup::Standard {
        discussion => 0,
        # name of Discussion pages
        discussionpage => 'Discussion',
-       # generate HTML5? (experimental)
+       # generate HTML5?
        html5 => 0,
        # only send cookies over SSL connections?
        sslcookie => 0,
@@ -71,8 +77,8 @@ use IkiWiki::Setup::Standard {
        numbacklinks => 10,
        # attempt to hardlink source files? (optimisation for large files)
        hardlink => 0,
-       # force ikiwiki to use a particular umask
-       #umask => 022,
+       # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
+       #umask => 'public',
        # group for wrappers to run in
        #wrappergroup => 'ikiwiki',
        # extra library and plugin directory
@@ -89,6 +95,12 @@ use IkiWiki::Setup::Standard {
        wiki_file_chars => '-[:alnum:]+/.:_',
        # allow symlinks in the path leading to the srcdir (potentially insecure)
        allow_symlinks_before_srcdir => 1,
+       # cookie control
+       cookiejar => {
+         file => $ENV{IKIWIKI_STATEDIR} . '/cookies'
+       },
+       # set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds
+       useragent => 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:26.0) Gecko/20100101 Firefox/26.0',
 
        ######################################################################
        # core plugins
@@ -129,7 +141,7 @@ use IkiWiki::Setup::Standard {
        # allow atom feeds to be used?
        #allowatom => 0,
        # urls to ping (using XML-RPC) on feed update
-       pingurl => [],
+       #pingurl => 'http://rpc.technorati.com/rpc/ping',
 
        ######################################################################
        # auth plugins
@@ -192,6 +204,8 @@ use IkiWiki::Setup::Standard {
        # mdwn plugin
        # enable multimarkdown features?
        multimarkdown => 1,
+       # disable use of markdown discount?
+       #nodiscount => 0,
 
        # po plugin
        # master language (non-PO files)
@@ -204,15 +218,47 @@ use IkiWiki::Setup::Standard {
        #po_link_to => 'current',
 
        ######################################################################
-       # misc plugins
-       #   (filecheck)
+       # special-purpose plugins
+       #   (osm, underlay)
        ######################################################################
 
+       # osm plugin
+       # the default zoom when you click on the map link
+       #osm_default_zoom => 15,
+       # the icon shown on links and on the main map
+       #osm_default_icon => 'ikiwiki/images/osm.png',
+       # the alt tag of links, defaults to empty
+       #osm_alt => '',
+       # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
+       #osm_format => 'KML',
+       # the icon attached to a tag, displayed on the map for tagged pages
+       #osm_tag_default_icon => 'icon.png',
+       # Url for the OpenLayers.js file
+       #osm_openlayers_url => 'http://www.openlayers.org/api/OpenLayers.js',
+       # Layers to use in the map. Can be either the 'OSM' string or a type option for Google maps (GoogleNormal, GoogleSatellite, GoogleHybrid or GooglePhysical). It can also be an arbitrary URL in a syntax acceptable for OpenLayers.Layer.OSM.url parameter.
+       #osm_layers => {
+       #  OSM => 'GoogleSatellite'
+       #},
+       # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
+       #osm_google_apikey => '',
+
+       # underlay plugin
+       # extra underlay directories to add
+       add_underlays => do {
+               my @underlaydirs;
+               push @underlaydirs, split /\s/, $ENV{IKIWIKI_UNDERLAYDIRS}
+                       if exists $ENV{IKIWIKI_UNDERLAYDIRS};
+               my $checkout_underlays = sprintf '%s/underlays', $ENV{IKIWIKI_CHECKOUTDIR};
+               push @underlaydirs, grep { -d } glob "$checkout_underlays/*"
+                       if -d $checkout_underlays;
+               \@underlaydirs;
+       },
+
        ######################################################################
        # web plugins
-       #   (404, attachment, comments, editdiff, edittemplate, feedreader,
-       #    getsource, google, goto, inlinedisplaymode, jquery,
-       #    mirrorlist, repolist, search, theme, websetup, wmd)
+       #   (404, attachment, comments, editdiff, edittemplate, getsource,
+       #    google, goto, mirrorlist, remove, rename, repolist, search,
+       #    theme, userlist, websetup, wmd)
        ######################################################################
 
        # attachment plugin
@@ -234,22 +280,18 @@ use IkiWiki::Setup::Standard {
        comments_allowauthor => 1,
        # commit comments to the VCS
        comments_commit => 1,
+       # Restrict formats for comments to (no restriction if empty)
+       #comments_allowformats => 'mdwn txt',
 
        # getsource plugin
        # Mime type for returned source.
        #getsource_mimetype => 'text/plain; charset=utf-8',
 
-       # jquery plugin
-       # version of jQuery to use, by default the latest version found is used
-       #jquery_version => '1.4.2',
-       # version of jQuery UI to use, by default the latest version found is used
-       #jquery_ui_version => '1.8.5',
-       # use jquery hosted at http://ajax.googleapis.com instead of local files, if enabled, jquery_version and optionally jquery_ui_version need to be set, disabled by default
-       #use_googleapis => 1,
-
        # mirrorlist plugin
        # list of mirrors
        #mirrorlist => {},
+       # generate links that point to the mirrors' ikiwiki CGI
+       #mirrorlist_use_cgi => 1,
 
        # repolist plugin
        # URIs of repositories containing the wiki's source
@@ -258,6 +300,8 @@ use IkiWiki::Setup::Standard {
        # search plugin
        # path to the omega cgi program
        omega_cgi => '/usr/lib/cgi-bin/omega/omega',
+       # use google site search rather than internal xapian index?
+       #google_search => 1,
 
        # theme plugin
        # name of theme to enable
@@ -274,10 +318,10 @@ use IkiWiki::Setup::Standard {
        ######################################################################
        # widget plugins
        #   (calendar, color, conditional, cutpaste, date, format, fortune,
-       #    graphviz, haiku, img, linkmap, listdirectives, map, more,
-       #    orphans, pagecount, pagestats, poll, polygen, postsparkline,
-       #    progress, shortcut, sparkline, table, template, teximg, toc,
-       #    toggle, version)
+       #    graphviz, haiku, headinganchors, img, linkmap, listdirectives,
+       #    map, more, orphans, pagecount, pagestats, poll, polygen,
+       #    postsparkline, progress, shortcut, sparkline, table, template,
+       #    teximg, toc, toggle, version)
        ######################################################################
 
        # calendar plugin
@@ -308,10 +352,11 @@ use IkiWiki::Setup::Standard {
        ######################################################################
        # other plugins
        #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed,
-       #    favicon, flattr, goodstuff, htmlbalance, localstyle,
-       #    pagetemplate, pingee, pinger, prettydate, recentchanges,
-       #    recentchangesdiff, relativedate, rsync, sidebar, smiley,
-       #    sortnaturally, tag, testpagespec, typography, underlay)
+       #    favicon, filecheck, flattr, goodstuff, htmlbalance,
+       #    localstyle, notifyemail, pagetemplate, pingee, pinger,
+       #    prettydate, recentchanges, recentchangesdiff, relativedate,
+       #    rsync, sidebar, smiley, sortnaturally, tag, testpagespec,
+       #    trail, transient, typography)
        ######################################################################
 
        # aggregate plugin
@@ -320,11 +365,6 @@ use IkiWiki::Setup::Standard {
        # allow aggregation to be triggered via the web?
        #aggregate_webtrigger => 0,
 
-       # cookie control
-       cookiejar => {
-         file => $ENV{IKIWIKI_STATEDIR} . '/cookies'
-       },
-
        # autoindex plugin
        # commit autocreated index pages
        #autoindex_commit => 1,
@@ -370,16 +410,4 @@ use IkiWiki::Setup::Standard {
        # typography plugin
        # Text::Typography attributes value
        #typographyattributes => 3,
-
-       # underlay plugin
-       # extra underlay directories to add
-       add_underlays => do {
-               my @underlaydirs;
-               push @underlaydirs, split /\s/, $ENV{IKIWIKI_UNDERLAYDIRS}
-                       if exists $ENV{IKIWIKI_UNDERLAYDIRS};
-               my $checkout_underlays = sprintf '%s/underlays', $ENV{IKIWIKI_CHECKOUTDIR};
-               push @underlaydirs, grep { -d } glob "$checkout_underlays/*"
-                       if -d $checkout_underlays;
-               \@underlaydirs;
-       },
 }