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