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   - pagestats
  44   - pagetemplate
  45   - po
  46   - prettydate
  47   - shortcut
  48   - sidebar2
  49   - tag
  50   - toc
  51   - toggle
  52   - typography
  53   - underlay
  54 # plugins to disable
  55 disable_plugins:
  56   - editpage
  57   - htmlscrubber
  58   - lockedit
  59   - openid
  60   - passwordauth
  61   - recentchanges
  62   - signinedit
  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: 1
  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: '(^^contribute\/how\/promote\/material\/.*|\/discussion\..*|\/Discussion\..*|\.(ar|fa|id|pl|sr_Latn|tr|zh|zh_TW)\.po$)'
 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, git, htmlscrubber, inline, link, meta, parentlinks)
 119 ######################################################################
 120
 121 # htmlscrubber plugin
 122 # PageSpec specifying pages not to scrub
 123 #htmlscrubber_skip: '!blueprint/*'
 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 # httpauth plugin
 148 # url to redirect to when authentication is needed
 149 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
 150 # PageSpec of pages where only httpauth will be used for authentication
 151 #httpauth_pagespec: '!*/Discussion'
 152
 153 # moderatedcomments plugin
 154 # PageSpec matching users or comment locations to moderate
 155 #moderate_pagespec: '*'
 156
 157 # openid plugin
 158 # url pattern of openid realm (default is cgiurl)
 159 #openid_realm: ''
 160 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 161 #openid_cgiurl: ''
 162
 163 ######################################################################
 164 # format plugins
 165 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, textile, txt)
 166 ######################################################################
 167
 168 # highlight plugin
 169 # types of source files to syntax highlight
 170 #tohighlight: .c .h .cpp .pl .py Makefile:make
 171 # location of highlight's filetypes.conf
 172 #filetypes_conf: /etc/highlight/filetypes.conf
 173 # location of highlight's langDefs directory
 174 #langdefdir: /usr/share/highlight/langDefs
 175
 176 # mdwn plugin
 177 # enable multimarkdown features?
 178 #multimarkdown: 0
 179
 180 # po plugin
 181 # master language (non-PO files)
 182 po_master_language: en|English
 183 # slave languages (translated via PO files) format: ll|Langname
 184 po_slave_languages:
 185   - ca|Català
 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: '!news/report_2* and !news/version_0* and !news/version_0*/* and !news/version_1* and !news/version_1*/* and !news/version_2* and !news/version_2*/* and !news/version_3* and !news/version_3*/* and !news/version_4* and !news/version_4*/* 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 ioerror or latest or news or news/* or sponsors 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 # repolist plugin
 240 # URIs of repositories containing the wiki's source
 241 #repositories:
 242 #  - svn://svn.example.org/wiki/trunk
 243
 244 # search plugin
 245 # path to the omega cgi program
 246 #omega_cgi: /usr/lib/cgi-bin/omega/omega
 247
 248 # theme plugin
 249 # name of theme to enable
 250 #theme: actiontabs
 251
 252 # websetup plugin
 253 # list of plugins that cannot be enabled/disabled via the web interface
 254 #websetup_force_plugins: []
 255 # list of additional setup field keys to treat as unsafe
 256 #websetup_unsafe: []
 257 # show unsafe settings, read-only, in web interface?
 258 #websetup_show_unsafe: 1
 259
 260 ######################################################################
 261 # widget plugins
 262 #   (calendar, color, conditional, cutpaste, date, format, fortune,
 263 #    graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
 264 #    pagecount, pagestats, poll, polygen, postsparkline, progress,
 265 #    shortcut, sparkline, table, template, teximg, toc, toggle, version)
 266 ######################################################################
 267
 268 # calendar plugin
 269 # base of the archives hierarchy
 270 #archivebase: archives
 271 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 272 #archive_pagespec: page(posts/*) and !*/Discussion
 273
 274 # listdirectives plugin
 275 # directory in srcdir that contains directive descriptions
 276 #directive_description_dir: ikiwiki/directive
 277
 278 # teximg plugin
 279 # Should teximg use dvipng to render, or dvips and convert?
 280 #teximg_dvipng: ''
 281 # LaTeX prefix for teximg plugin
 282 #teximg_prefix: |
 283 #  \documentclass{article}
 284 #  \usepackage[utf8]{inputenc}
 285 #  \usepackage{amsmath}
 286 #  \usepackage{amsfonts}
 287 #  \usepackage{amssymb}
 288 #  \pagestyle{empty}
 289 #  \begin{document}
 290 # LaTeX postfix for teximg plugin
 291 #teximg_postfix: '\end{document}'
 292
 293 ######################################################################
 294 # other plugins
 295 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
 296 #    flattr, goodstuff, htmlbalance, localstyle, pagetemplate, pandoc,
 297 #    pingee, pinger, prettydate, recentchanges, recentchangesdiff,
 298 #    relativedate, rsync, sidebar, smiley, sortnaturally, tag,
 299 #    testpagespec, transient, underlay)
 300 ######################################################################
 301
 302 # aggregate plugin
 303 # enable aggregation to internal pages?
 304 #aggregateinternal: 1
 305 # allow aggregation to be triggered via the web?
 306 #aggregate_webtrigger: 0
 307 # cookie control
 308 #cookiejar:
 309 #  file: /home/user/.ikiwiki/cookies
 310
 311 # autoindex plugin
 312 # commit autocreated index pages
 313 #autoindex_commit: 1
 314
 315 # camelcase plugin
 316 # list of words to not turn into links
 317 #camelcase_ignore: []
 318
 319 # flattr plugin
 320 # userid or user name to use by default for Flattr buttons
 321 #flattr_userid: joeyh
 322
 323 # pandoc plugin
 324 # Path to pandoc executable
 325 #pandoc_command: /usr/bin/pandoc
 326 # File extension for Markdown files
 327 #pandoc_markdown_ext: mdwn
 328 # Enable Pandoc processing of LaTeX documents
 329 #pandoc_latex: 0
 330 # Enable Pandoc processing of reStructuredText documents
 331 #pandoc_rst: 0
 332 # Use smart quotes, dashes, and ellipses
 333 #pandoc_smart: 1
 334 # Output format (html, markdown or latex)
 335 #pandoc_output_format: html
 336 # Path depth of which LaTeX parts roots (e.g.: bla/part1 = depth 2)
 337 #pandoc_parts_at_depth: 1
 338 # Shift headers level depending on page depth (default: enabled for LaTeX output, disabled else)
 339 #pandoc_shift_headers: 1
 340
 341 # pinger plugin
 342 # how many seconds to try pinging before timing out
 343 #pinger_timeout: 15
 344
 345 # prettydate plugin
 346 # format to use to display date
 347 prettydateformat: '%Y-%m-%d'
 348
 349 # recentchanges plugin
 350 # name of the recentchanges page
 351 #recentchangespage: recentchanges
 352 # number of changes to track
 353 #recentchangesnum: 100
 354
 355 # rsync plugin
 356 # command to run to sync updated pages
 357 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
 358
 359 # sidebar plugin
 360 # show sidebar page on all pages?
 361 #global_sidebars: 1
 362
 363 # tag plugin
 364 # parent page tags are located under
 365 tagbase: tags
 366 # autocreate new tag pages?
 367 #tag_autocreate: 1
 368 # commit autocreated tag pages
 369 #tag_autocreate_commit: 1
 370
 371 # underlay plugin
 372 # extra underlay directories to add
 373 add_underlays:
 374   - /home/amnesia/Persistent/Tails/promotion-material
 375
 376 # sidebar2 plugin
 377 # https://ikiwiki.info/plugins/contrib/sidebar2/
 378 global_sidebars:
 379   - banner
 380   - banner
 381   - "*"
 382   - sidebar
 383   - sidebar
 384   - "*"
 385   - footer
 386   - footer
 387   - "*"
 388 #  - year-end
 389 #  - donate/year-end
 390 #  - "*"