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