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