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