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