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