ikiwiki.setup

   1 # -*- mode: yaml; -*-
   2 # IkiWiki::Setup::Yaml - YAML formatted setup file
   3 #
   4 # Setup file for ikiwiki.
   5 #
   6 # Passing this to ikiwiki --setup will make ikiwiki generate
   7 # wrappers and build the wiki.
   8 #
   9 # Remember to re-run ikiwiki --setup any time you edit this file.
  10 #
  11 # name of the wiki
  12 wikiname: The Amnesic Incognito Live System
  13 # contact email for wiki
  14 adminemail: tails@boum.org
  15 # users who are wiki admins
  16 adminuser: []
  17 # users who are banned from the wiki
  18 banned_users: []
  19 # where the source of the wiki is located
  20 srcdir: wiki/src
  21 # where to build the wiki
  22 destdir: config/chroot_local-includes/usr/share/doc/tails/website
  23 # base url to the wiki
  24 url: file:///usr/share/doc/tails/website
  25 # url to the ikiwiki.cgi
  26 cgiurl: ''
  27 # filename of cgi wrapper to generate
  28 cgi_wrapper: ''
  29 # mode for cgi_wrapper (can safely be made suid)
  30 cgi_wrappermode: 06755
  31 # rcs backend to use
  32 rcs: ''
  33 # plugins to add to the default configuration
  34 add_plugins:
  35   - favicon
  36   - html
  37   - map
  38   - mirrorlist
  39   - po
  40   - shortcut
  41   - sidebar
  42   - tag
  43   - toc
  44   - typography
  45   - comments
  46   - meta
  47   - img
  48   - lockedit
  49   - toggle
  50 # plugins to disable
  51 disable_plugins:
  52   - openid
  53   - httpauth
  54   - signinedit
  55   - passwordauth
  56   - editpage
  57   - recentchanges
  58 # additional directory to search for template files
  59 # templatedir: /usr/share/ikiwiki/templates
  60 # base wiki source location
  61 # underlaydir: /usr/share/ikiwiki/basewiki
  62 # display verbose messages?
  63 verbose: 1
  64 # log to syslog?
  65 #syslog: 1
  66 # create output files named page/index.html?
  67 usedirs: 0
  68 # use '!'-prefixed preprocessor directives?
  69 prefix_directives: 1
  70 # use page/index.mdwn source files
  71 indexpages: 0
  72 # enable Discussion pages?
  73 discussion: 0
  74 # name of Discussion pages
  75 discussionpage: Discussion
  76 # generate HTML5? (experimental)
  77 html5: 0
  78 # only send cookies over SSL connections?
  79 sslcookie: 0
  80 # extension to use for new pages
  81 default_pageext: mdwn
  82 # extension to use for html files
  83 htmlext: html
  84 # strftime format string to display date
  85 timeformat: '%c'
  86 # UTF-8 locale to use
  87 locale: en_US.UTF-8
  88 # put user pages below specified page
  89 userdir: ''
  90 # how many backlinks to show before hiding excess (0 to show all)
  91 numbacklinks: 10
  92 # attempt to hardlink source files? (optimisation for large files)
  93 hardlink: 0
  94 # force ikiwiki to use a particular umask
  95 #umask: 022
  96 # group for wrappers to run in
  97 #wrappergroup: ikiwiki
  98 # extra library and plugin directory
  99 libdir: ''
 100 # environment variables
 101 ENV: {}
 102 # regexp of normally excluded files to include
 103 include: '^\.htaccess$'
 104 # regexp of files that should be skipped
 105 exclude: (?-xism:/discussion)
 106 # specifies the characters that are allowed in source filenames
 107 wiki_file_chars: '-[:alnum:]+/.:_'
 108 # allow symlinks in the path leading to the srcdir (potentially insecure)
 109 allow_symlinks_before_srcdir: 1
 110
 111 ######################################################################
 112 # core plugins
 113 #   (editpage, htmlscrubber, inline, link, meta, parentlinks)
 114 ######################################################################
 115
 116 # htmlscrubber plugin
 117 # PageSpec specifying pages not to scrub
 118 #htmlscrubber_skip: '!*/Discussion'
 119
 120 # inline plugin
 121 # enable rss feeds by default?
 122 rss: 0
 123 # enable atom feeds by default?
 124 atom: 0
 125 # allow rss feeds to be used?
 126 #allowrss: 0
 127 # allow atom feeds to be used?
 128 #allowatom: 0
 129 # urls to ping (using XML-RPC) on feed update
 130 pingurl: []
 131
 132 ######################################################################
 133 # auth plugins
 134 #   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
 135 #    opendiscussion, openid, passwordauth, signinedit)
 136 ######################################################################
 137
 138 # anonok plugin
 139 # PageSpec to limit which pages anonymous users can edit
 140 #anonok_pagespec: '*/discussion'
 141
 142 # blogspam plugin
 143 # PageSpec of pages to check for spam
 144 #blogspam_pagespec: postcomment(*)
 145 # options to send to blogspam server
 146 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
 147 # blogspam server XML-RPC url
 148 #blogspam_server: ''
 149
 150 # httpauth plugin
 151 # url to redirect to when authentication is needed
 152 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
 153 # PageSpec of pages where only httpauth will be used for authentication
 154 #httpauth_pagespec: '!*/Discussion'
 155
 156 # lockedit plugin
 157 # PageSpec controlling which pages are locked
 158 locked_pages: '.htaccess or inc/* or download or doc/about/openpgp_keys or sidebar or support or torrents/rss* or index or recentchanges or index/Discussion or shortcuts or shortcuts.* or contribute/release_process'
 159
 160 # moderatedcomments plugin
 161 # PageSpec matching users or comment locations to moderate
 162 #moderate_pagespec: '*'
 163
 164 # openid plugin
 165 # url pattern of openid realm (default is cgiurl)
 166 #openid_realm: ''
 167 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 168 #openid_cgiurl: ''
 169
 170 # passwordauth plugin
 171 # a password that must be entered when signing up for an account
 172 #account_creation_password: s3cr1t
 173 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
 174 #password_cost: 8
 175
 176 ######################################################################
 177 # format plugins
 178 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, textile, txt)
 179 ######################################################################
 180
 181 # highlight plugin
 182 # types of source files to syntax highlight
 183 #tohighlight: .c .h .cpp .pl .py Makefile:make
 184 # location of highlight's filetypes.conf
 185 #filetypes_conf: /etc/highlight/filetypes.conf
 186 # location of highlight's langDefs directory
 187 #langdefdir: /usr/share/highlight/langDefs
 188
 189 # mdwn plugin
 190 # enable multimarkdown features?
 191 #multimarkdown: 0
 192
 193 # po plugin
 194 # master language (non-PO files)
 195 po_master_language: en|English
 196 # slave languages (translated via PO files) format: ll|Langname
 197 po_slave_languages:
 198   - de|Deutsch
 199   - es|Español
 200   - fr|Français
 201 # PageSpec controlling which pages are translatable
 202 po_translatable_pages: '!security/audits and !security/audits/* and (about or chat or contribute or doc or doc/* or download or getting_started or inc/stable_i386_date or index or news or security or security/* or sidebar or support or support/* or torrents or wishlist)'
 203 # internal linking behavior (default/current/negotiated)
 204 po_link_to: current
 205
 206 ######################################################################
 207 # misc plugins
 208 #   (filecheck)
 209 ######################################################################
 210
 211 ######################################################################
 212 # web plugins
 213 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
 214 #    goto, mirrorlist, remove, rename, repolist, search, theme, websetup,
 215 #    wmd)
 216 ######################################################################
 217
 218 # attachment plugin
 219 # enhanced PageSpec specifying what attachments are allowed
 220 #allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
 221 # virus checker program (reads STDIN, returns nonzero if virus found)
 222 #virus_checker: clamdscan -
 223
 224 # comments plugin
 225 # PageSpec of pages where comments are allowed
 226 comments_pagespec: forum/*
 227 # PageSpec of pages where posting new comments is not allowed
 228 comments_closed_pagespec: ''
 229 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 230 comments_pagename: comment_
 231 # Interpret directives in comments?
 232 #comments_allowdirectives: 0
 233 # Allow anonymous commenters to set an author name?
 234 #comments_allowauthor: 0
 235 # commit comments to the VCS
 236 comments_commit: 1
 237
 238 # getsource plugin
 239 # Mime type for returned source.
 240 #getsource_mimetype: text/plain; charset=utf-8
 241
 242 # mirrorlist plugin
 243 # list of mirrors
 244 mirrorlist:
 245   tails.boum.org: https://tails.boum.org/ikiwiki.cgi
 246 # generate links that point to the mirrors' ikiwiki CGI
 247 mirrorlist_use_cgi: 1
 248
 249 # repolist plugin
 250 # URIs of repositories containing the wiki's source
 251 #repositories:
 252 #  - svn://svn.example.org/wiki/trunk
 253
 254 # search plugin
 255 # path to the omega cgi program
 256 #omega_cgi: /usr/lib/cgi-bin/omega/omega
 257
 258 # theme plugin
 259 # name of theme to enable
 260 #theme: actiontabs
 261
 262 # websetup plugin
 263 # list of plugins that cannot be enabled/disabled via the web interface
 264 #websetup_force_plugins: []
 265 # list of additional setup field keys to treat as unsafe
 266 #websetup_unsafe: []
 267 # show unsafe settings, read-only, in web interface?
 268 #websetup_show_unsafe: 1
 269
 270 ######################################################################
 271 # widget plugins
 272 #   (calendar, color, conditional, cutpaste, date, format, fortune,
 273 #    graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
 274 #    pagecount, pagestats, poll, polygen, postsparkline, progress,
 275 #    shortcut, sparkline, table, template, teximg, toc, toggle, version)
 276 ######################################################################
 277
 278 # calendar plugin
 279 # base of the archives hierarchy
 280 #archivebase: archives
 281 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 282 #archive_pagespec: page(posts/*) and !*/Discussion
 283
 284 # listdirectives plugin
 285 # directory in srcdir that contains directive descriptions
 286 #directive_description_dir: ikiwiki/directive
 287
 288 # teximg plugin
 289 # Should teximg use dvipng to render, or dvips and convert?
 290 #teximg_dvipng: ''
 291 # LaTeX prefix for teximg plugin
 292 #teximg_prefix: |
 293 #  \documentclass{article}
 294 #  \usepackage[utf8]{inputenc}
 295 #  \usepackage{amsmath}
 296 #  \usepackage{amsfonts}
 297 #  \usepackage{amssymb}
 298 #  \pagestyle{empty}
 299 #  \begin{document}
 300 # LaTeX postfix for teximg plugin
 301 #teximg_postfix: '\end{document}'
 302
 303 ######################################################################
 304 # other plugins
 305 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
 306 #    flattr, goodstuff, htmlbalance, localstyle, pagetemplate, pandoc,
 307 #    pingee, pinger, prettydate, recentchanges, recentchangesdiff,
 308 #    relativedate, rsync, sidebar, smiley, sortnaturally, tag,
 309 #    testpagespec, transient, underlay)
 310 ######################################################################
 311
 312 # aggregate plugin
 313 # enable aggregation to internal pages?
 314 #aggregateinternal: 1
 315 # allow aggregation to be triggered via the web?
 316 #aggregate_webtrigger: 0
 317 # cookie control
 318 #cookiejar:
 319 #  file: /home/user/.ikiwiki/cookies
 320
 321 # autoindex plugin
 322 # commit autocreated index pages
 323 #autoindex_commit: 1
 324
 325 # camelcase plugin
 326 # list of words to not turn into links
 327 #camelcase_ignore: []
 328
 329 # flattr plugin
 330 # userid or user name to use by default for Flattr buttons
 331 #flattr_userid: joeyh
 332
 333 # pandoc plugin
 334 # Path to pandoc executable
 335 #pandoc_command: /usr/bin/pandoc
 336 # File extension for Markdown files
 337 #pandoc_markdown_ext: mdwn
 338 # Enable Pandoc processing of LaTeX documents
 339 #pandoc_latex: 0
 340 # Enable Pandoc processing of reStructuredText documents
 341 #pandoc_rst: 0
 342 # Use smart quotes, dashes, and ellipses
 343 #pandoc_smart: 1
 344 # Output format (html, markdown or latex)
 345 #pandoc_output_format: html
 346 # Path depth of which LaTeX parts roots (e.g.: bla/part1 = depth 2)
 347 #pandoc_parts_at_depth: 1
 348 # Shift headers level depending on page depth (default: enabled for LaTeX output, disabled else)
 349 #pandoc_shift_headers: 1
 350
 351 # pinger plugin
 352 # how many seconds to try pinging before timing out
 353 #pinger_timeout: 15
 354
 355 # prettydate plugin
 356 # format to use to display date
 357 #prettydateformat: '%X, %B %o, %Y'
 358
 359 # recentchanges plugin
 360 # name of the recentchanges page
 361 #recentchangespage: recentchanges
 362 # number of changes to track
 363 #recentchangesnum: 100
 364
 365 # rsync plugin
 366 # command to run to sync updated pages
 367 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
 368
 369 # sidebar plugin
 370 # show sidebar page on all pages?
 371 #global_sidebars: 1
 372
 373 # tag plugin
 374 # parent page tags are located under
 375 tagbase: tags
 376 # autocreate new tag pages?
 377 #tag_autocreate: 1
 378 # commit autocreated tag pages
 379 tag_autocreate_commit: 1
 380
 381 # underlay plugin
 382 # extra underlay directories to add
 383 #add_underlays:
 384 #  - /home/user/wiki.underlay