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