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