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