Convert ikiwiki.setup to YAML

1 files changed, 415 insertions, 122 deletions

diff --git a/ikiwiki/ikiwiki.setup b/ikiwiki/ikiwiki.setup
index 9f9448f..4c892ac 100644
--- a/ikiwiki/ikiwiki.setup
+++ b/ikiwiki/ikiwiki.setup
@@ -1,125 +1,418 @@
-#!/usr/bin/perl
-# Configuration file for ikiwiki.
-# Passing this to ikiwiki --setup will make ikiwiki generate wrappers and
-# build the wiki.
+# IkiWiki::Setup::Yaml - YAML formatted setup file
+#
+# Setup file for ikiwiki.
+#
+# 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.
+#
+# name of the wiki
+wikiname: Templates
+# contact email for wiki
+adminemail: templates@fluxo.info
+# users who are wiki admins
+adminuser: []
+# users who are banned from the wiki
+banned_users: []
+# where the source of the wiki is located
+srcdir: .
+# where to build the wiki
+destdir: www
+# base url to the wiki
+url: https://templates.fluxo.info
+# url to the ikiwiki.cgi
+cgiurl: ''
+# do not adjust cgiurl if CGI is accessed via different URL
+reverse_proxy: 0
+# filename of cgi wrapper to generate
+cgi_wrapper: ''
+# 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
+# plugins to add to the default configuration
+add_plugins:
+- goodstuff
+- sidebar
+# plugins to disable
+disable_plugins:
+- openid
+- editpage
+# additional directory to search for template files
+templatedir: /usr/share/ikiwiki/templates
+# base wiki source location
+underlaydir: /usr/share/ikiwiki/basewiki
+# display verbose messages?
+#verbose: 1
+# log to syslog?
+#syslog: 1
+# create output files named page/index.html?
+usedirs: 1
+# use '!'-prefixed preprocessor directives?
+prefix_directives: 1
+# use page/index.mdwn source files
+indexpages: 0
+# enable Discussion pages?
+discussion: 0
+# name of Discussion pages
+discussionpage: Discussion
+# generate HTML5?
+html5: 0
+# only send cookies over SSL connections?
+sslcookie: 0
+# extension to use for new pages
+default_pageext: mdwn
+# extension to use for html files
+htmlext: html
+# strftime format string to display date
+timeformat: '%c'
+# UTF-8 locale to use
+#locale: en_US.UTF-8
+# put user pages below specified page
+userdir: ''
+# how many backlinks to show before hiding excess (0 to show all)
+numbacklinks: 10
+# attempt to hardlink source files? (optimisation for large files)
+hardlink: 1
+# force ikiwiki to use a particular umask (keywords public, group or private, or a number)
+umask: 2
+# group for wrappers to run in
+#wrappergroup: ikiwiki
+# extra library and plugin directory
+libdir: ''
+# environment variables
+ENV: {}
+# time zone name
+#timezone: US/Eastern
+# regexp of normally excluded files to include
+#include: ^\.htaccess$
+# regexp of files that should be skipped
+exclude: (?^:www)
+# specifies the characters that are allowed in source filenames
+wiki_file_chars: -[:alnum:]+/.:_
+# allow symlinks in the path leading to the srcdir (potentially insecure)
+allow_symlinks_before_srcdir: 0
+# cookie control
+cookiejar:
+  file: /home/rhatto/.ikiwiki/cookies
+# set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds
+useragent: ikiwiki/3.20141016.4
+
+######################################################################
+# core plugins
+#   (editpage, git, htmlscrubber, inline, link, meta, parentlinks,
+#    templatebody)
+######################################################################
+
+# git plugin
+# git hook to generate
+#git_wrapper: /git/wiki.git/hooks/post-update
+# shell command for git_wrapper to run, in the background
+#git_wrapper_background_command: git push github
+# mode for git_wrapper (can safely be made suid)
+#git_wrappermode: 06755
+# git pre-receive hook to generate
+#git_test_receive_wrapper: /git/wiki.git/hooks/pre-receive
+# unix users whose commits should be checked by the pre-receive hook
+#untrusted_committers: []
+# gitweb url to show file history ([[file]] substituted)
+historyurl: https://git.fluxo.info/templates/log/[[file]]
+# gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
+diffurl: https://git.fluxo.info/templates/commit/[[file]]?id=[[sha1_commit]]
+# where to pull and push changes (set to empty string to disable)
+gitorigin_branch: ''
+# branch that the wiki is stored in
+gitmaster_branch: master
+
+# htmlscrubber plugin
+# PageSpec specifying pages not to scrub
+#htmlscrubber_skip: '!*/Discussion'
+
+# inline plugin
+# enable rss feeds by default?
+rss: 1
+# enable atom feeds by default?
+#atom: 0
+# allow rss feeds to be used?
+#allowrss: 0
+# allow atom feeds to be used?
+#allowatom: 0
+# urls to ping (using XML-RPC) on feed update
+pingurl: []
+
+######################################################################
+# auth plugins
+#   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
+#    opendiscussion, openid, passwordauth, signinedit)
+######################################################################
+
+# anonok plugin
+# PageSpec to limit which pages anonymous users can edit
+#anonok_pagespec: '*/discussion'
+
+# blogspam plugin
+# PageSpec of pages to check for spam
+#blogspam_pagespec: postcomment(*)
+# options to send to blogspam server
+#blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
+# blogspam server JSON url
+#blogspam_server: ''
+
+# httpauth plugin
+# url to redirect to when authentication is needed
+#cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
+# PageSpec of pages where only httpauth will be used for authentication
+#httpauth_pagespec: '!*/Discussion'
+
+# lockedit plugin
+# PageSpec controlling which pages are locked
+#locked_pages: '!*/Discussion'
+
+# moderatedcomments plugin
+# PageSpec matching users or comment locations to moderate
+#moderate_pagespec: '*'
+
+# openid plugin
+# url pattern of openid realm (default is cgiurl)
+#openid_realm: ''
+# url to ikiwiki cgi to use for openid authentication (default is cgiurl)
+#openid_cgiurl: ''
+
+# passwordauth plugin
+# a password that must be entered when signing up for an account
+#account_creation_password: s3cr1t
+# cost of generating a password using Authen::Passphrase::BlowfishCrypt
+#password_cost: 8
+
+######################################################################
+# format plugins
+#   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
+#    txt)
+######################################################################
+
+# highlight plugin
+# types of source files to syntax highlight
+#tohighlight: .c .h .cpp .pl .py Makefile:make
+# location of highlight's filetypes.conf
+#filetypes_conf: /etc/highlight/filetypes.conf
+# location of highlight's langDefs directory
+#langdefdir: /usr/share/highlight/langDefs
+
+# mdwn plugin
+# enable multimarkdown features?
+#multimarkdown: 0
+# disable use of markdown discount?
+#nodiscount: 0
+
+# po plugin
+# master language (non-PO files)
+#po_master_language: en|English
+# slave languages (translated via PO files) format: ll|Langname
+#po_slave_languages:
+#- fr|Français
+#- es|Español
+#- de|Deutsch
+# PageSpec controlling which pages are translatable
+#po_translatable_pages: '* and !*/Discussion'
+# internal linking behavior (default/current/negotiated)
+#po_link_to: current
+
+######################################################################
+# 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:
+#- /home/rhatto/wiki.underlay
+
+######################################################################
+# web plugins
+#   (404, attachment, comments, editdiff, edittemplate, getsource, google,
+#    goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
+#    websetup, wmd)
+######################################################################
+
+# attachment plugin
+# enhanced PageSpec specifying what attachments are allowed
+#allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
+# virus checker program (reads STDIN, returns nonzero if virus found)
+#virus_checker: clamdscan -
+
+# comments plugin
+# PageSpec of pages where comments are allowed
+#comments_pagespec: blog/* and !*/Discussion
+# PageSpec of pages where posting new comments is not allowed
+#comments_closed_pagespec: blog/controversial or blog/flamewar
+# Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
+#comments_pagename: ''
+# Interpret directives in comments?
+#comments_allowdirectives: 0
+# Allow anonymous commenters to set an author name?
+#comments_allowauthor: 0
+# 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
+
+# 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
+#repositories:
+#- svn://svn.example.org/wiki/trunk
+
+# 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
+#theme: actiontabs
+
+# websetup plugin
+# list of plugins that cannot be enabled/disabled via the web interface
+#websetup_force_plugins: []
+# list of additional setup field keys to treat as unsafe
+#websetup_unsafe: []
+# show unsafe settings, read-only, in web interface?
+#websetup_show_unsafe: 1
+
+######################################################################
+# widget plugins
+#   (calendar, color, conditional, cutpaste, date, format, fortune,
+#    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
+# base of the archives hierarchy
+#archivebase: archives
+# PageSpec of pages to include in the archives; used by ikiwiki-calendar command
+#archive_pagespec: page(posts/*) and !*/Discussion
+
+# img plugin
+# Image formats to process (jpeg, png, gif, svg, pdf or 'everything' to accept all)
+#img_allowed_formats: ''
+
+# listdirectives plugin
+# directory in srcdir that contains directive descriptions
+#directive_description_dir: ikiwiki/directive
+
+# teximg plugin
+# Should teximg use dvipng to render, or dvips and convert?
+#teximg_dvipng: ''
+# LaTeX prefix for teximg plugin
+#teximg_prefix: '\documentclass{article}
+#
+#  \usepackage[utf8]{inputenc}
+#
+#  \usepackage{amsmath}
+#
+#  \usepackage{amsfonts}
+#
+#  \usepackage{amssymb}
+#
+#  \pagestyle{empty}
+#
+#  \begin{document}
+#
+#'
+# LaTeX postfix for teximg plugin
+#teximg_postfix: \end{document}
+
+######################################################################
+# other plugins
+#   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
+#    filecheck, flattr, goodstuff, htmlbalance, localstyle, notifyemail,
+#    pagetemplate, pingee, pinger, prettydate, recentchanges,
+#    recentchangesdiff, relativedate, rsync, sidebar, smiley,
+#    sortnaturally, tag, testpagespec, trail, transient)
+######################################################################
+
+# aggregate plugin
+# enable aggregation to internal pages?
+#aggregateinternal: 1
+# allow aggregation to be triggered via the web?
+#aggregate_webtrigger: 0
+
+# autoindex plugin
+# commit autocreated index pages
+#autoindex_commit: 1
+
+# camelcase plugin
+# list of words to not turn into links
+#camelcase_ignore: []
+
+# flattr plugin
+# userid or user name to use by default for Flattr buttons
+#flattr_userid: joeyh
+
+# pinger plugin
+# how many seconds to try pinging before timing out
+#pinger_timeout: 15
+
+# prettydate plugin
+# format to use to display date
+#prettydateformat: '%X, %B %o, %Y'
+
+# recentchanges plugin
+# name of the recentchanges page
+recentchangespage: recentchanges
+# number of changes to track
+recentchangesnum: 100
+
+# rsync plugin
+# command to run to sync updated pages
+#rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
+
+# sidebar plugin
+# show sidebar page on all pages?
+#global_sidebars: 1
 
-use IkiWiki::Setup::Standard {
-  wikiname       => "Templates",
-  admintemplates => ["templates", ],
-  adminemail     => 'templates@fluxo.info',
-
-  # Be sure to customise these..
-  srcdir  => ".",
-  destdir => "www",
-
-  url          => "https://templates.fluxo.info",
-  #templatedir => "/usr/share/ikiwiki/templates",
-  #underlaydir => "/usr/share/ikiwiki/basewiki",
-
-  # Git stuff.
-  rcs        => "git",
-  # Cgit
-  historyurl => "https://git.fluxo.info/templates/log/[[file]]",
-  diffurl => 'https://git.fluxo.info/templates/commit/[[file]]?id=[[sha1_commit]]',
-  # Gitweb
-  #historyurl => "https://gitweb.fluxo.info/?p=templates.git;a=history;f=[[file]]",
-  #diffurl    => "https://gitweb.fluxo.info/?p=templates.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
-  #gitorigin_branch => "origin",
-  #gitmaster_branch => "master",
-  # See https://ikiwiki.info/tips/laptop_wiki_with_git/
-  gitorigin_branch => '',
-
-  wrappers => [
-    #{
-    #  # The git post-update wrapper.
-    #  # Note that this will overwrite any existing
-    #  # post-update hook script, which may not be
-    #  # what you want.
-    #  wrapper      => "/var/git/repositories/rhatto.git/hooks/post-update",
-    #  wrappermode  => "06550",
-    #  wrappergroup => "git",
-    #},
-  ],
-
-  # Default to generating rss and atom feeds for pages with feeds?
-  rss   => 1,
-  #atom => 1,
-
-  # Allow generating feeds even if not generated by default?
-  #allowrss  => 1,
-  #allowatom => 1,
-
-  # 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 => 0,
-
-  # To exclude files matching a regexp from processing. This adds to
-  # the default exclude list.
-  #exclude => qr/\.wav$/,
-  exclude => qr/www/,
-
-  # To change the extension used for generated html files.
-  #htmlext => 'htm',
-
-  # Time format (for strftime)
-  #timeformat => '%c',
-
-  # Locale to use. Must be a UTF-8 locale.
-  #locale => 'en_US.UTF-8',
-
-  # Logging settings:
-  #verbose => 1,
-  syslog => 0,
-
-  # To link to templates pages in a subdirectory of the wiki.
-  #templatesdir => "templates",
-
-  # Uncomment to force ikiwiki to run with a particular umask.
-  umask => 002,
-
-  # Default settings for the recentchanges page.
-  #recentchangespage => "recentchanges",
-  #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
-  #                   htmltidy fortune sidebar map rst anonok}],
-  add_plugins => [qw{goodstuff sidebar}],
-
-  # If you want to disable any of the default plugins, list them here.
-  #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
-  disable_plugins => [qw{openid editpage}],
-
-  # 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",
-
-  # See https://ikiwiki.info/plugins/po/
-  #po_master_language => 'en|English',
-  #po_slave_languages => [ 'pt|Portuguese' ],
-
-  # See http://ikiwiki.info/plugins/rsync/
-  #rsync_command => 'rsync -qa --delete . templates@host:/path/to/docroot/',
-}
+# tag plugin
+# parent page tags are located under
+#tagbase: tag
+# autocreate new tag pages?
+#tag_autocreate: 1
+# commit autocreated tag pages
+tag_autocreate_commit: 1