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: Tails
  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   - sidebar2
  50   - tag
  51   - toc
  52   - toggle
  53   - trail
  54   - typography
  55   - underlay
  56 # plugins to disable
  57 disable_plugins:
  58   - editpage
  59   - htmlscrubber
  60   - lockedit
  61   - openid
  62   - passwordauth
  63   - recentchanges
  64   - signinedit
  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: 1
  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: '(^^contribute\/how\/promote\/material\/.*|\/discussion\..*|\/Discussion\..*|\.(ar|ca|fa|id|pl|sr_Latn|tr|zh|zh_TW)\.po$)'
 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, git, htmlscrubber, inline, link, meta, parentlinks)
 121 ######################################################################
 122
 123 # htmlscrubber plugin
 124 # PageSpec specifying pages not to scrub
 125 #htmlscrubber_skip: '!blueprint/*'
 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 # httpauth plugin
 150 # url to redirect to when authentication is needed
 151 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
 152 # PageSpec of pages where only httpauth will be used for authentication
 153 #httpauth_pagespec: '!*/Discussion'
 154
 155 # moderatedcomments plugin
 156 # PageSpec matching users or comment locations to moderate
 157 #moderate_pagespec: '*'
 158
 159 # openid plugin
 160 # url pattern of openid realm (default is cgiurl)
 161 #openid_realm: ''
 162 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 163 #openid_cgiurl: ''
 164
 165 ######################################################################
 166 # format plugins
 167 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, textile, txt)
 168 ######################################################################
 169
 170 # highlight plugin
 171 # types of source files to syntax highlight
 172 #tohighlight: .c .h .cpp .pl .py Makefile:make
 173 # location of highlight's filetypes.conf
 174 #filetypes_conf: /etc/highlight/filetypes.conf
 175 # location of highlight's langDefs directory
 176 #langdefdir: /usr/share/highlight/langDefs
 177
 178 # mdwn plugin
 179 # enable multimarkdown features?
 180 #multimarkdown: 0
 181
 182 # po plugin
 183 # master language (non-PO files)
 184 po_master_language: en|English
 185 # slave languages (translated via PO files) format: ll|Langname
 186 po_slave_languages:
 187   - de|Deutsch
 188   - es|Español
 189   - fr|Français
 190   - it|Italiano
 191   - pt|Português
 192   - ru|Русский
 193 # PageSpec controlling which pages are translatable
 194 #
 195 # On each release `n` of Tails 3.0, 4.0, etc. this list should be
 196 # updated to disable translations of news/version_* for release `n-2`.
 197 #
 198 # When updating this list, refer to the checklist in
 199 # https://tails.boum.org/contribute/how/website/po_translatable_pages/
 200 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/version_3* and !news/test_* and !security/Numerous_security_holes_in_* and (about or about/* or banner or bugs or chat or contribute or doc or doc/* or donate or donate/* or download or download.inline or footer or getting_started or home or home/* or index or latest or news or news/* or sponsors 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/*)'
 201 # internal linking behavior (default/current/negotiated)
 202 po_link_to: current
 203
 204 ######################################################################
 205 # misc plugins
 206 #   (filecheck)
 207 ######################################################################
 208
 209 ######################################################################
 210 # web plugins
 211 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
 212 #    goto, mirrorlist, remove, rename, repolist, search, theme, websetup,
 213 #    wmd)
 214 ######################################################################
 215
 216 # attachment plugin
 217 # enhanced PageSpec specifying what attachments are allowed
 218 #allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
 219 # virus checker program (reads STDIN, returns nonzero if virus found)
 220 #virus_checker: clamdscan -
 221
 222 # comments plugin
 223 # PageSpec of pages where comments are allowed
 224 #comments_pagespec: forum/*
 225 # PageSpec of pages where posting new comments is not allowed
 226 #comments_closed_pagespec: ''
 227 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 228 #comments_pagename: comment_
 229 # Interpret directives in comments?
 230 #comments_allowdirectives: 0
 231 # Allow anonymous commenters to set an author name?
 232 #comments_allowauthor: 0
 233 # commit comments to the VCS
 234 #comments_commit: 1
 235
 236 # getsource plugin
 237 # Mime type for returned source.
 238 #getsource_mimetype: text/plain; charset=utf-8
 239
 240 # mirrorlist plugin
 241 # list of mirrors
 242 mirrorlist:
 243   tails.boum.org: https://tails.boum.org/ikiwiki.cgi
 244 # generate links that point to the mirrors' ikiwiki CGI
 245 mirrorlist_use_cgi: 1
 246
 247 # repolist plugin
 248 # URIs of repositories containing the wiki's source
 249 #repositories:
 250 #  - svn://svn.example.org/wiki/trunk
 251
 252 # search plugin
 253 # path to the omega cgi program
 254 #omega_cgi: /usr/lib/cgi-bin/omega/omega
 255
 256 # theme plugin
 257 # name of theme to enable
 258 #theme: actiontabs
 259
 260 # websetup plugin
 261 # list of plugins that cannot be enabled/disabled via the web interface
 262 #websetup_force_plugins: []
 263 # list of additional setup field keys to treat as unsafe
 264 #websetup_unsafe: []
 265 # show unsafe settings, read-only, in web interface?
 266 #websetup_show_unsafe: 1
 267
 268 ######################################################################
 269 # widget plugins
 270 #   (calendar, color, conditional, cutpaste, date, format, fortune,
 271 #    graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
 272 #    pagecount, pagestats, poll, polygen, postsparkline, progress,
 273 #    shortcut, sparkline, table, template, teximg, toc, toggle, version)
 274 ######################################################################
 275
 276 # calendar plugin
 277 # base of the archives hierarchy
 278 #archivebase: archives
 279 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 280 #archive_pagespec: page(posts/*) and !*/Discussion
 281
 282 # listdirectives plugin
 283 # directory in srcdir that contains directive descriptions
 284 #directive_description_dir: ikiwiki/directive
 285
 286 # teximg plugin
 287 # Should teximg use dvipng to render, or dvips and convert?
 288 #teximg_dvipng: ''
 289 # LaTeX prefix for teximg plugin
 290 #teximg_prefix: |
 291 #  \documentclass{article}
 292 #  \usepackage[utf8]{inputenc}
 293 #  \usepackage{amsmath}
 294 #  \usepackage{amsfonts}
 295 #  \usepackage{amssymb}
 296 #  \pagestyle{empty}
 297 #  \begin{document}
 298 # LaTeX postfix for teximg plugin
 299 #teximg_postfix: '\end{document}'
 300
 301 ######################################################################
 302 # other plugins
 303 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
 304 #    flattr, goodstuff, htmlbalance, localstyle, pagetemplate, pandoc,
 305 #    pingee, pinger, prettydate, recentchanges, recentchangesdiff,
 306 #    relativedate, rsync, sidebar, smiley, sortnaturally, tag,
 307 #    testpagespec, transient, underlay)
 308 ######################################################################
 309
 310 # aggregate plugin
 311 # enable aggregation to internal pages?
 312 #aggregateinternal: 1
 313 # allow aggregation to be triggered via the web?
 314 #aggregate_webtrigger: 0
 315 # cookie control
 316 #cookiejar:
 317 #  file: /home/user/.ikiwiki/cookies
 318
 319 # autoindex plugin
 320 # commit autocreated index pages
 321 #autoindex_commit: 1
 322
 323 # camelcase plugin
 324 # list of words to not turn into links
 325 #camelcase_ignore: []
 326
 327 # flattr plugin
 328 # userid or user name to use by default for Flattr buttons
 329 #flattr_userid: joeyh
 330
 331 # pandoc plugin
 332 # Path to pandoc executable
 333 #pandoc_command: /usr/bin/pandoc
 334 # File extension for Markdown files
 335 #pandoc_markdown_ext: mdwn
 336 # Enable Pandoc processing of LaTeX documents
 337 #pandoc_latex: 0
 338 # Enable Pandoc processing of reStructuredText documents
 339 #pandoc_rst: 0
 340 # Use smart quotes, dashes, and ellipses
 341 #pandoc_smart: 1
 342 # Output format (html, markdown or latex)
 343 #pandoc_output_format: html
 344 # Path depth of which LaTeX parts roots (e.g.: bla/part1 = depth 2)
 345 #pandoc_parts_at_depth: 1
 346 # Shift headers level depending on page depth (default: enabled for LaTeX output, disabled else)
 347 #pandoc_shift_headers: 1
 348
 349 # pinger plugin
 350 # how many seconds to try pinging before timing out
 351 #pinger_timeout: 15
 352
 353 # prettydate plugin
 354 # format to use to display date
 355 prettydateformat: '%Y-%m-%d'
 356
 357 # recentchanges plugin
 358 # name of the recentchanges page
 359 #recentchangespage: recentchanges
 360 # number of changes to track
 361 #recentchangesnum: 100
 362
 363 # rsync plugin
 364 # command to run to sync updated pages
 365 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
 366
 367 # sidebar plugin
 368 # show sidebar page on all pages?
 369 #global_sidebars: 1
 370
 371 # tag plugin
 372 # parent page tags are located under
 373 tagbase: tags
 374 # autocreate new tag pages?
 375 #tag_autocreate: 1
 376 # commit autocreated tag pages
 377 #tag_autocreate_commit: 1
 378
 379 # underlay plugin
 380 # extra underlay directories to add
 381 add_underlays:
 382   - /home/amnesia/Persistent/Tails/promotion-material
 383
 384 # sidebar2 plugin
 385 # https://ikiwiki.info/plugins/contrib/sidebar2/
 386 global_sidebars:
 387   - banner
 388   - banner
 389   - "*"
 390   - sidebar
 391   - sidebar
 392   - "*"
 393   - footer
 394   - footer
 395   - "*"
 396   - year-end
 397   - donate/year-end
 398   - "*"