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