ikiwiki-cgi.setup 13.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
# -*- mode: yaml; -*-
# IkiWiki::Setup::Yaml - YAML formatted setup file
#
# Setup file for ikiwiki.
# 
# Passing this to ikiwiki --setup will make ikiwiki generate
# wrappers and build the wiki.
# 
# Remember to re-run ikiwiki --setup any time you edit this file.
#
# name of the wiki
wikiname: The Amnesic Incognito Live System
# contact email for wiki
14
adminemail: tails@boum.org
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
# users who are wiki admins
adminuser: []
# users who are banned from the wiki
banned_users: []
# where the source of the wiki is located
srcdir: wiki/src
# where to build the wiki
destdir: /var/www/wiki/tails
# base url to the wiki
url: http://localhost/wiki/tails
# url to the ikiwiki.cgi
cgiurl: http://localhost/wiki/tails/ikiwiki.cgi
# filename of cgi wrapper to generate
cgi_wrapper: ''
# mode for cgi_wrapper (can safely be made suid)
cgi_wrappermode: 06755
31 32
# try harder to produce deterministic output
deterministic: 1
33 34 35 36
# rcs backend to use
rcs: git
# plugins to add to the default configuration
add_plugins:
37
  - editpage
38 39
  - favicon
  - html
40
  - lockedit
41 42
  - map
  - mirrorlist
43
  - passwordauth
44 45 46 47 48
  - po
  - shortcut
  - sidebar
  - tag
  - toc
49
  - trail
50 51 52
  - typography
  - meta
  - img
53
  - pagestats
54 55
  - recentchanges
  - search
56
  - toggle
57
  - underlay
58 59
# plugins to disable
disable_plugins:
60
  - anonok
61 62
  - openid
  - httpauth
63 64
  - remove
  - rename
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
  - signinedit
# additional directory to search for template files
# templatedir: /usr/share/ikiwiki/templates
# base wiki source location
# underlaydir: /usr/share/ikiwiki/basewiki
# display verbose messages?
verbose: 1
# log to syslog?
#syslog: 1
# create output files named page/index.html?
usedirs: 0
# use '!'-prefixed preprocessor directives?
prefix_directives: 1
# use page/index.mdwn source files
indexpages: 0
# enable Discussion pages?
discussion: 0
# name of Discussion pages
discussionpage: Discussion
# generate HTML5? (experimental)
html5: 0
# only send cookies over SSL connections?
sslcookie: 0
# extension to use for new pages
default_pageext: mdwn
# extension to use for html files
htmlext: html
# strftime format string to display date
timeformat: '%c'
# UTF-8 locale to use
locale: en_US.UTF-8
# put user pages below specified page
userdir: ''
# how many backlinks to show before hiding excess (0 to show all)
numbacklinks: 10
# attempt to hardlink source files? (optimisation for large files)
hardlink: 0
# force ikiwiki to use a particular umask
umask: 18
# group for wrappers to run in
#wrappergroup: ikiwiki
# extra library and plugin directory
libdir: ''
# environment variables
ENV: {}
# 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 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
# allow symlinks in the path leading to the srcdir (potentially insecure)
allow_symlinks_before_srcdir: 1

######################################################################
# core plugins
#   (editpage, git, htmlscrubber, inline, link, meta, parentlinks)
######################################################################

# git plugin
# git hook to generate
#git_wrapper: /git/wiki.git/hooks/post-update
# shell command for git_wrapper to run, in the background
#git_wrapper_background_command: git push github
# mode for git_wrapper (can safely be made suid)
#git_wrappermode: 06755
# git pre-receive hook to generate
#git_test_receive_wrapper: /git/wiki.git/hooks/pre-receive
# unix users whose commits should be checked by the pre-receive hook
#untrusted_committers: []
# 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 140 141 142 143 144 145
# where to pull and push changes (set to empty string to disable)
gitorigin_branch: ''
# branch that the wiki is stored in
gitmaster_branch: master

# htmlscrubber plugin
# 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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

# inline plugin
# enable rss feeds by default?
rss: 1
# enable atom feeds by default?
atom: 1
# allow rss feeds to be used?
#allowrss: 0
# allow atom feeds to be used?
#allowatom: 0
# urls to ping (using XML-RPC) on feed update
pingurl: []

######################################################################
# auth plugins
#   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
#    opendiscussion, openid, passwordauth, signinedit)
######################################################################

# anonok plugin
# PageSpec to limit which pages anonymous users can edit
#anonok_pagespec: '*/discussion'

# blogspam plugin
# PageSpec of pages to check for spam
#blogspam_pagespec: postcomment(*)
# options to send to blogspam server
#blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
# blogspam server XML-RPC url
#blogspam_server: ''

# httpauth plugin
# url to redirect to when authentication is needed
#cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
# PageSpec of pages where only httpauth will be used for authentication
#httpauth_pagespec: '!*/Discussion'

# lockedit plugin
# PageSpec controlling which pages are locked
186
locked_pages: '! blueprint/*'
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226

# moderatedcomments plugin
# PageSpec matching users or comment locations to moderate
#moderate_pagespec: '*'

# openid plugin
# url pattern of openid realm (default is cgiurl)
#openid_realm: ''
# url to ikiwiki cgi to use for openid authentication (default is cgiurl)
#openid_cgiurl: ''

# passwordauth plugin
# a password that must be entered when signing up for an account
#account_creation_password: s3cr1t
# cost of generating a password using Authen::Passphrase::BlowfishCrypt
#password_cost: 8

######################################################################
# format plugins
#   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, textile, txt)
######################################################################

# highlight plugin
# types of source files to syntax highlight
#tohighlight: .c .h .cpp .pl .py Makefile:make
# location of highlight's filetypes.conf
#filetypes_conf: /etc/highlight/filetypes.conf
# location of highlight's langDefs directory
#langdefdir: /usr/share/highlight/langDefs

# mdwn plugin
# enable multimarkdown features?
#multimarkdown: 0

# po plugin
# master language (non-PO files)
po_master_language: en|English
# slave languages (translated via PO files) format: ll|Langname
po_slave_languages:
  - de|Deutsch
transbot's avatar
transbot committed
227
  - es|Español
sajolida's avatar
sajolida committed
228
  - fa|Farsi
229
  - fr|Français
230
  - it|Italiano
231
  - pt|Português
232
# PageSpec controlling which pages are translatable
233
#
sajolida's avatar
sajolida committed
234
# On each release `n` of Tails 3.0, 4.0, etc. this list should be
235 236
# updated to disable translations of news/version_*, news/test_*, and
# security/Numerous_security_holes_in_* for release `n-2`.
237 238 239
#
# When updating this list, refer to the checklist in
# 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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
# internal linking behavior (default/current/negotiated)
po_link_to: current

######################################################################
# misc plugins
#   (filecheck)
######################################################################

######################################################################
# web plugins
#   (404, attachment, comments, editdiff, edittemplate, getsource, google,
#    goto, mirrorlist, remove, rename, repolist, search, theme, websetup,
#    wmd)
######################################################################

# attachment plugin
# enhanced PageSpec specifying what attachments are allowed
#allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
# virus checker program (reads STDIN, returns nonzero if virus found)
#virus_checker: clamdscan -

# comments plugin
# 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"
Tails developers's avatar
Tails developers committed
268
#comments_pagename: comment_
269 270 271 272 273
# Interpret directives in comments?
#comments_allowdirectives: 0
# Allow anonymous commenters to set an author name?
#comments_allowauthor: 0
# commit comments to the VCS
Tails developers's avatar
Tails developers committed
274
#comments_commit: 1
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

# getsource plugin
# Mime type for returned source.
#getsource_mimetype: text/plain; charset=utf-8

# mirrorlist plugin
# list of mirrors
mirrorlist:
  tails.boum.org: https://tails.boum.org/ikiwiki.cgi
# generate links that point to the mirrors' ikiwiki CGI
mirrorlist_use_cgi: 1

# repolist plugin
# URIs of repositories containing the wiki's source
#repositories:
#  - svn://svn.example.org/wiki/trunk

# search plugin
# path to the omega cgi program
omega_cgi: /usr/lib/cgi-bin/omega/omega

# theme plugin
# name of theme to enable
#theme: actiontabs

# websetup plugin
# list of plugins that cannot be enabled/disabled via the web interface
#websetup_force_plugins: []
# list of additional setup field keys to treat as unsafe
#websetup_unsafe: []
# show unsafe settings, read-only, in web interface?
#websetup_show_unsafe: 1

######################################################################
# widget plugins
#   (calendar, color, conditional, cutpaste, date, format, fortune,
#    graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
#    pagecount, pagestats, poll, polygen, postsparkline, progress,
#    shortcut, sparkline, table, template, teximg, toc, toggle, version)
######################################################################

# calendar plugin
# base of the archives hierarchy
#archivebase: archives
# PageSpec of pages to include in the archives; used by ikiwiki-calendar command
#archive_pagespec: page(posts/*) and !*/Discussion

# listdirectives plugin
# directory in srcdir that contains directive descriptions
#directive_description_dir: ikiwiki/directive

# teximg plugin
# Should teximg use dvipng to render, or dvips and convert?
#teximg_dvipng: ''
# LaTeX prefix for teximg plugin
#teximg_prefix: |
#  \documentclass{article}
#  \usepackage[utf8]{inputenc}
#  \usepackage{amsmath}
#  \usepackage{amsfonts}
#  \usepackage{amssymb}
#  \pagestyle{empty}
#  \begin{document}
# LaTeX postfix for teximg plugin
#teximg_postfix: '\end{document}'

######################################################################
# other plugins
#   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
#    flattr, goodstuff, htmlbalance, localstyle, pagetemplate, pandoc,
#    pingee, pinger, prettydate, recentchanges, recentchangesdiff,
#    relativedate, rsync, sidebar, smiley, sortnaturally, tag,
#    testpagespec, transient, underlay)
######################################################################

# aggregate plugin
# enable aggregation to internal pages?
#aggregateinternal: 1
# allow aggregation to be triggered via the web?
#aggregate_webtrigger: 0
# cookie control
#cookiejar:
#  file: /home/user/.ikiwiki/cookies

# autoindex plugin
# commit autocreated index pages
#autoindex_commit: 1

# camelcase plugin
# list of words to not turn into links
#camelcase_ignore: []

# flattr plugin
# userid or user name to use by default for Flattr buttons
#flattr_userid: joeyh

# pandoc plugin
# Path to pandoc executable
#pandoc_command: /usr/bin/pandoc
# File extension for Markdown files
#pandoc_markdown_ext: mdwn
# Enable Pandoc processing of LaTeX documents
#pandoc_latex: 0
# Enable Pandoc processing of reStructuredText documents
#pandoc_rst: 0
# Use smart quotes, dashes, and ellipses
#pandoc_smart: 1
# Output format (html, markdown or latex)
#pandoc_output_format: html
# Path depth of which LaTeX parts roots (e.g.: bla/part1 = depth 2)
#pandoc_parts_at_depth: 1
# Shift headers level depending on page depth (default: enabled for LaTeX output, disabled else)
#pandoc_shift_headers: 1

# pinger plugin
# how many seconds to try pinging before timing out
#pinger_timeout: 15

# prettydate plugin
# format to use to display date
#prettydateformat: '%X, %B %o, %Y'

# recentchanges plugin
# name of the recentchanges page
recentchangespage: recentchanges
# number of changes to track
recentchangesnum: 100

# rsync plugin
# command to run to sync updated pages
#rsync_command: rsync -qa --delete . user@host:/path/to/docroot/

# sidebar plugin
# show sidebar page on all pages?
#global_sidebars: 1

# tag plugin
# parent page tags are located under
tagbase: tags
# autocreate new tag pages?
#tag_autocreate: 1
# commit autocreated tag pages
tag_autocreate_commit: 1

# underlay plugin
# extra underlay directories to add
421 422
add_underlays:
  - /home/amnesia/Persistent/Tails/promotion-material