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