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