2010-10-19 23:35:22 +00:00
# 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: git-annex
# contact email for wiki
adminemail: joey@kitenet.net
# users who are wiki admins
adminuser:
2012-05-27 00:19:12 +00:00
- http://joey.kitenet.net/
- http://joeyh.name/
2010-10-19 23:35:22 +00:00
# users who are banned from the wiki
banned_users: []
# where the source of the wiki is located
2010-10-19 23:39:23 +00:00
srcdir: /home/b-git-annex/source/doc
2010-10-19 23:35:22 +00:00
# where to build the wiki
destdir: /home/b-git-annex/public_html
# base url to the wiki
url: http://git-annex.branchable.com
# url to the ikiwiki.cgi
cgiurl: http://git-annex.branchable.com/ikiwiki.cgi
# filename of cgi wrapper to generate
2011-05-15 20:35:09 +00:00
cgi_wrapper: /var/www/b-git-annex/ikiwiki.cgi
2010-10-19 23:35:22 +00:00
# mode for cgi_wrapper (can safely be made suid)
2012-05-27 00:19:12 +00:00
cgi_wrappermode: '0755'
2012-12-14 18:49:20 +00:00
# number of seconds to delay CGI requests when overloaded
cgi_overload_delay: ''
# message to display when overloaded (may contain html)
cgi_overload_message: ''
2010-10-19 23:35:22 +00:00
# rcs backend to use
rcs: git
# plugins to add to the default configuration
add_plugins:
2012-05-27 00:19:12 +00:00
- goodstuff
- websetup
- '404'
- ikiwikihosting
- branchable
- recentchangesdiff
- attachment
- remove
- rename
- edittemplate
- favicon
- format
- fortune
- highlight
- listdirectives
- poll
- progress
- relativedate
- testpagespec
- version
- theme
- sidebar
- comments
- aggregate
- gitpush
- template
- notifyemail
- trail
2012-07-16 19:22:39 +00:00
- search
2012-08-09 20:23:54 +00:00
- shortcut
2012-12-14 18:49:20 +00:00
- calendar
2012-07-26 17:29:35 +00:00
# plugins to disable
disable_plugins:
- blogspam
2010-10-19 23:35:22 +00:00
# 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?
2012-05-27 00:19:12 +00:00
syslog: '1'
2010-10-19 23:35:22 +00:00
# create output files named page/index.html?
2012-05-27 00:19:12 +00:00
usedirs: '1'
2010-10-19 23:35:22 +00:00
# use '!'-prefixed preprocessor directives?
2012-05-27 00:19:12 +00:00
prefix_directives: '1'
2010-10-19 23:35:22 +00:00
# use page/index.mdwn source files
2012-05-27 00:19:12 +00:00
indexpages: '0'
2010-10-19 23:35:22 +00:00
# enable Discussion pages?
2012-05-27 00:19:12 +00:00
discussion: '0'
2010-10-19 23:35:22 +00:00
# name of Discussion pages
discussionpage: Discussion
2011-07-03 19:16:20 +00:00
# generate HTML5?
2012-05-27 00:19:12 +00:00
html5: '0'
2010-10-19 23:35:22 +00:00
# only send cookies over SSL connections?
2012-05-27 00:19:12 +00:00
sslcookie: '0'
2010-10-19 23:35:22 +00:00
# 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
2010-11-14 18:11:09 +00:00
userdir: users
2010-10-19 23:35:22 +00:00
# how many backlinks to show before hiding excess (0 to show all)
2012-05-27 00:19:12 +00:00
numbacklinks: '10'
2010-10-19 23:35:22 +00:00
# attempt to hardlink source files? (optimisation for large files)
2012-05-27 00:19:12 +00:00
hardlink: '1'
# force ikiwiki to use a particular umask (keywords public, group or private, or a number)
#umask: public
2010-10-19 23:35:22 +00:00
# group for wrappers to run in
#wrappergroup: ikiwiki
# extra library and plugin directory
libdir: /home/b-git-annex/.ikiwiki
# environment variables
ENV: {}
2011-03-24 17:59:47 +00:00
# time zone name
timezone: GMT
2010-10-19 23:35:22 +00:00
# regexp of normally excluded files to include
2012-05-27 00:19:12 +00:00
#include: ^\.htaccess$
2010-10-19 23:35:22 +00:00
# regexp of files that should be skipped
2012-05-27 00:19:12 +00:00
#exclude: ^(*\.private|Makefile)$
2010-10-19 23:35:22 +00:00
# specifies the characters that are allowed in source filenames
2012-05-27 00:19:12 +00:00
wiki_file_chars: -[:alnum:]+/.:_
2010-10-19 23:35:22 +00:00
# allow symlinks in the path leading to the srcdir (potentially insecure)
2012-05-27 00:19:12 +00:00
allow_symlinks_before_srcdir: '0'
2010-10-19 23:35:22 +00:00
######################################################################
# core plugins
2011-05-13 23:12:51 +00:00
# (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
# inline, link, meta, parentlinks)
2010-10-19 23:35:22 +00:00
######################################################################
# branchable plugin
# Allow anyone to branch, check out, and copy this site?
2012-05-27 00:19:12 +00:00
branchable: '1'
2011-05-15 20:35:09 +00:00
# Allow anyone to git push verified changes to this site?
2012-05-27 00:19:12 +00:00
anonpush: '1'
2010-10-19 23:35:22 +00:00
# Display "Branchable" link on action bar?
2012-05-27 00:19:12 +00:00
branchable_action: '1'
2010-10-19 23:35:22 +00:00
# git plugin
# git hook to generate
git_wrapper: /home/b-git-annex/source.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)
2012-05-27 00:19:12 +00:00
#git_wrappermode: '06755'
2010-10-19 23:35:22 +00:00
# git pre-receive hook to generate
2011-05-19 20:08:07 +00:00
git_test_receive_wrapper: /home/b-git-annex/source.git/hooks/pre-receive
2010-10-19 23:35:22 +00:00
# unix users whose commits should be checked by the pre-receive hook
2011-05-15 20:35:09 +00:00
untrusted_committers:
2012-05-27 00:19:12 +00:00
- ikiwiki-anon
2010-10-19 23:35:22 +00:00
# gitweb url to show file history ([[file]] substituted)
2012-05-27 00:19:12 +00:00
historyurl: http://source.git-annex.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD
2010-10-19 23:35:22 +00:00
# gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
2012-05-27 00:19:12 +00:00
diffurl: http://source.git-annex.branchable.com/?p=source.git;a=blobdiff;f=doc/[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]
2010-10-19 23:35:22 +00:00
# where to pull and push changes (set to empty string to disable)
2010-10-19 23:35:31 +00:00
gitorigin_branch: origin
2010-10-19 23:35:22 +00:00
# branch that the wiki is stored in
2010-10-19 23:35:31 +00:00
gitmaster_branch: master
2010-10-19 23:35:22 +00:00
2011-05-13 23:12:51 +00:00
# gitpush plugin
# git repository urls that changes are pushed to
git_push_to:
2012-05-27 00:19:12 +00:00
- git@github.com:joeyh/git-annex.git
- joey@git.kitenet.net:/srv/git/git-annex
2011-05-13 23:12:51 +00:00
2010-10-19 23:35:22 +00:00
# htmlscrubber plugin
# PageSpec specifying pages not to scrub
2012-04-13 19:35:46 +00:00
htmlscrubber_skip: testimonials
2010-10-19 23:35:22 +00:00
2011-05-13 23:12:51 +00:00
# ikiwikihosting plugin
# list of urls that alias to the main url
#urlalias: []
# openid of primary site owner
owner: http://joey.kitenet.net/
# optional hostname of site this one was branched from
#parent: ''
# internal hostname of this site
hostname: git-annex.branchable.com
# site creation datestamp
2012-05-27 00:19:12 +00:00
created: '1287531313'
2011-05-13 23:12:51 +00:00
# how many days to retain logs
#log_period: 7
# disable IPv6?
2012-05-27 00:19:12 +00:00
ipv6_disabled: '0'
2011-05-13 23:12:51 +00:00
2010-10-19 23:35:22 +00:00
# inline plugin
# enable rss feeds by default?
2012-05-27 00:19:12 +00:00
rss: '1'
2010-10-19 23:35:22 +00:00
# enable atom feeds by default?
2012-05-27 00:19:12 +00:00
atom: '1'
2010-10-19 23:35:22 +00:00
# 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
2010-10-19 23:35:31 +00:00
pingurl: []
2010-10-19 23:35:22 +00:00
######################################################################
# 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
2010-11-14 18:08:31 +00:00
blogspam_pagespec: postcomment(*)
2010-10-19 23:35:22 +00:00
# options to send to blogspam server
2012-05-27 00:19:12 +00:00
#blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
2010-10-19 23:35:22 +00:00
# blogspam server XML-RPC 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
2012-04-13 19:35:46 +00:00
locked_pages: testimonials
2010-10-19 23:35:22 +00:00
# moderatedcomments plugin
# PageSpec matching users or comment locations to moderate
#moderate_pagespec: '*'
# openid plugin
# url pattern of openid realm (default is cgiurl)
openid_realm: http://*.branchable.com/
# url to ikiwiki cgi to use for openid authentication (default is cgiurl)
openid_cgiurl: http://git-annex.branchable.com/ikiwiki.cgi
# 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
2013-03-01 17:04:28 +00:00
tohighlight: ''
2010-10-19 23:35:22 +00:00
# location of highlight's filetypes.conf
2010-10-19 23:35:31 +00:00
filetypes_conf: /etc/highlight/filetypes.conf
2010-10-19 23:35:22 +00:00
# location of highlight's langDefs directory
2010-10-19 23:35:31 +00:00
langdefdir: /usr/share/highlight/langDefs
2010-10-19 23:35:22 +00:00
# mdwn plugin
# enable multimarkdown features?
#multimarkdown: 0
2012-05-27 00:19:12 +00:00
# disable use of markdown discount?
#nodiscount: 0
2010-10-19 23:35:22 +00:00
# po plugin
# master language (non-PO files)
#po_master_language: en|English
# slave languages (translated via PO files) format: ll|Langname
#po_slave_languages:
2012-05-27 00:19:12 +00:00
#- fr|Français
#- es|Español
#- de|Deutsch
2010-10-19 23:35:22 +00:00
# PageSpec controlling which pages are translatable
2010-10-19 23:40:32 +00:00
po_translatable_pages: ''
2010-10-19 23:35:22 +00:00
# internal linking behavior (default/current/negotiated)
2010-10-19 23:40:32 +00:00
po_link_to: default
2010-10-19 23:35:22 +00:00
######################################################################
2012-05-27 00:19:12 +00:00
# special-purpose plugins
# (osm)
2010-10-19 23:35:22 +00:00
######################################################################
2012-05-27 00:19:12 +00:00
# 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
2012-12-14 18:49:20 +00:00
# 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: ''
2012-05-27 00:19:12 +00:00
2010-10-19 23:35:22 +00:00
######################################################################
# web plugins
2012-05-27 00:19:12 +00:00
# (404, attachment, comments, editdiff, edittemplate, google, goto,
# mirrorlist, remove, rename, repolist, search, theme, userlist,
2011-07-03 19:16:20 +00:00
# websetup, wmd)
2010-10-19 23:35:22 +00:00
######################################################################
# attachment plugin
# enhanced PageSpec specifying what attachments are allowed
allowed_attachments: admin() and virusfree()
# virus checker program (reads STDIN, returns nonzero if virus found)
virus_checker: clamdscan -
# comments plugin
# PageSpec of pages where comments are allowed
2012-05-27 00:19:12 +00:00
comments_pagespec: page(*) and !*/Discussion and !ikiwiki/* and !index and !forum
and !bugs and !todo and !news and !recentchanges and !comments and !walkthrough
2012-06-04 20:19:28 +00:00
and !design/assistant/blog
2010-10-19 23:35:22 +00:00
# PageSpec of pages where posting new comments is not allowed
2010-10-19 23:40:32 +00:00
comments_closed_pagespec: ''
2010-10-19 23:35:22 +00:00
# Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
2010-10-19 23:40:32 +00:00
comments_pagename: comment_
2010-10-19 23:35:22 +00:00
# Interpret directives in comments?
#comments_allowdirectives: 0
# Allow anonymous commenters to set an author name?
#comments_allowauthor: 0
# commit comments to the VCS
2012-05-27 00:19:12 +00:00
comments_commit: '1'
2011-07-03 19:16:20 +00:00
2010-10-19 23:35:22 +00:00
# mirrorlist plugin
# list of mirrors
#mirrorlist: {}
2012-12-14 18:49:20 +00:00
# generate links that point to the mirrors' ikiwiki CGI
#mirrorlist_use_cgi: 1
2010-10-19 23:35:22 +00:00
# repolist plugin
# URIs of repositories containing the wiki's source
2010-10-19 23:35:31 +00:00
repositories:
2012-05-27 00:19:12 +00:00
- ssh://b-git-annex@git-annex.branchable.com/
- git://git-annex.branchable.com/
2010-10-19 23:35:22 +00:00
# search plugin
# path to the omega cgi program
2010-10-19 23:35:31 +00:00
omega_cgi: /usr/lib/cgi-bin/omega/omega
2010-10-19 23:35:22 +00:00
# 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:
2012-05-27 00:19:12 +00:00
- httpauth
- openid
- mdwn
- wmd
2010-10-19 23:35:22 +00:00
# list of additional setup field keys to treat as unsafe
websetup_unsafe:
2012-05-27 00:19:12 +00:00
- url
- cgiurl
- verbose
- syslog
- usedirs
- prefix_directives
- indexpages
- repositories
- sslcookie
2010-10-19 23:35:22 +00:00
# show unsafe settings, read-only, in web interface?
2012-05-27 00:19:12 +00:00
websetup_show_unsafe: '0'
2010-10-19 23:35:22 +00:00
######################################################################
# widget plugins
# (calendar, color, conditional, cutpaste, date, format, fortune,
2011-07-03 19:16:20 +00:00
# graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
# more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
# progress, shortcut, sparkline, table, template, teximg, toc, toggle,
# version)
2010-10-19 23:35:22 +00:00
######################################################################
# calendar plugin
# base of the archives hierarchy
2012-12-16 19:17:14 +00:00
archivebase: ''
2010-10-19 23:35:22 +00:00
# PageSpec of pages to include in the archives; used by ikiwiki-calendar command
2012-12-16 19:17:14 +00:00
archive_pagespec: ''
2010-10-19 23:35:22 +00:00
# listdirectives plugin
# directory in srcdir that contains directive descriptions
2010-10-19 23:35:31 +00:00
directive_description_dir: ikiwiki/directive
2010-10-19 23:35:22 +00:00
# teximg plugin
# Should teximg use dvipng to render, or dvips and convert?
#teximg_dvipng: ''
# LaTeX prefix for teximg plugin
2012-05-27 00:19:12 +00:00
#teximg_prefix: '\documentclass{article}
#
2010-10-19 23:35:22 +00:00
# \usepackage[utf8]{inputenc}
2012-05-27 00:19:12 +00:00
#
2010-10-19 23:35:22 +00:00
# \usepackage{amsmath}
2012-05-27 00:19:12 +00:00
#
2010-10-19 23:35:22 +00:00
# \usepackage{amsfonts}
2012-05-27 00:19:12 +00:00
#
2010-10-19 23:35:22 +00:00
# \usepackage{amssymb}
2012-05-27 00:19:12 +00:00
#
2010-10-19 23:35:22 +00:00
# \pagestyle{empty}
2012-05-27 00:19:12 +00:00
#
2010-10-19 23:35:22 +00:00
# \begin{document}
2012-05-27 00:19:12 +00:00
#
#'
2010-10-19 23:35:22 +00:00
# LaTeX postfix for teximg plugin
2012-05-27 00:19:12 +00:00
#teximg_postfix: \end{document}
2010-10-19 23:35:22 +00:00
######################################################################
# other plugins
# (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
2012-05-27 00:19:12 +00:00
# filecheck, flattr, goodstuff, htmlbalance, localstyle, missingsite,
# notifyemail, pagetemplate, parked, pingee, pinger, prettydate,
# recentchanges, recentchangesdiff, relativedate, rsync, sidebar,
# smiley, sortnaturally, tag, testpagespec, trail, transient,
# typography, underlay)
2010-10-19 23:35:22 +00:00
######################################################################
# aggregate plugin
# enable aggregation to internal pages?
2012-05-27 00:19:12 +00:00
aggregateinternal: '1'
2010-10-19 23:35:22 +00:00
# allow aggregation to be triggered via the web?
#aggregate_webtrigger: 0
2011-03-24 17:59:47 +00:00
# cookie control
cookiejar:
file: /home/b-git-annex/.ikiwiki/cookies
# autoindex plugin
# commit autocreated index pages
2012-05-27 00:19:12 +00:00
autoindex_commit: '1'
2010-10-19 23:35:22 +00:00
# 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
# parked plugin
# An optional message explaining why this site is parked.
#parked_message: ''
# pinger plugin
# how many seconds to try pinging before timing out
#pinger_timeout: 15
# prettydate plugin
# format to use to display date
2010-10-19 23:40:32 +00:00
prettydateformat: '%X, %B %o, %Y'
2010-10-19 23:35:22 +00:00
# recentchanges plugin
# name of the recentchanges page
2010-10-19 23:35:31 +00:00
recentchangespage: recentchanges
2010-10-19 23:35:22 +00:00
# number of changes to track
2012-05-27 00:19:12 +00:00
recentchangesnum: '100'
2010-10-19 23:35:22 +00:00
# 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
# tag plugin
# parent page tags are located under
#tagbase: tag
# autocreate new tag pages?
#tag_autocreate: 1
2011-03-24 17:59:47 +00:00
# commit autocreated tag pages
2012-05-27 00:19:12 +00:00
tag_autocreate_commit: '1'
2010-10-19 23:35:22 +00:00
# typography plugin
# Text::Typography attributes value
2012-05-27 00:19:12 +00:00
#typographyattributes: '3'
2010-10-19 23:35:22 +00:00
# underlay plugin
# extra underlay directories to add
#add_underlays:
2012-05-27 00:19:12 +00:00
#- /home/b-git-annex/wiki.underlay