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