ikiwiki.setup 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399
  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: config/chroot_local-includes/usr/share/doc/tails/website
  23. # base url to the wiki
  24. url: file:///usr/share/doc/tails/website
  25. # url to the ikiwiki.cgi
  26. cgiurl: ''
  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: ''
  35. # plugins to add to the default configuration
  36. add_plugins:
  37. - favicon
  38. - html
  39. - map
  40. - mirrorlist
  41. - po
  42. - shortcut
  43. - sidebar
  44. - tag
  45. - toc
  46. - typography
  47. - meta
  48. - img
  49. - pagestats
  50. - toggle
  51. - trail
  52. - underlay
  53. # plugins to disable
  54. disable_plugins:
  55. - comments
  56. - openid
  57. - httpauth
  58. - lockedit
  59. - signinedit
  60. - passwordauth
  61. - editpage
  62. - recentchanges
  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: 022
  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: '(^blueprint\/.*|^contribute\/how\/promote\/material\/.*|\/discussion\..*|\/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. # core plugins
  117. # (editpage, htmlscrubber, inline, link, meta, parentlinks)
  118. ######################################################################
  119. # htmlscrubber plugin
  120. # PageSpec specifying pages not to scrub
  121. 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 install or install.* or install/* or upgrade or upgrade.* or upgrade/*'
  122. # inline plugin
  123. # enable rss feeds by default?
  124. rss: 0
  125. # enable atom feeds by default?
  126. atom: 0
  127. # allow rss feeds to be used?
  128. #allowrss: 0
  129. # allow atom feeds to be used?
  130. #allowatom: 0
  131. # urls to ping (using XML-RPC) on feed update
  132. pingurl: []
  133. ######################################################################
  134. # auth plugins
  135. # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
  136. # opendiscussion, openid, passwordauth, signinedit)
  137. ######################################################################
  138. # anonok plugin
  139. # PageSpec to limit which pages anonymous users can edit
  140. #anonok_pagespec: '*/discussion'
  141. # blogspam plugin
  142. # PageSpec of pages to check for spam
  143. #blogspam_pagespec: postcomment(*)
  144. # options to send to blogspam server
  145. #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
  146. # blogspam server XML-RPC url
  147. #blogspam_server: ''
  148. # httpauth plugin
  149. # url to redirect to when authentication is needed
  150. #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
  151. # PageSpec of pages where only httpauth will be used for authentication
  152. #httpauth_pagespec: '!*/Discussion'
  153. # lockedit plugin
  154. # PageSpec controlling which pages are locked
  155. #locked_pages:
  156. # moderatedcomments plugin
  157. # PageSpec matching users or comment locations to moderate
  158. #moderate_pagespec: '*'
  159. # openid plugin
  160. # url pattern of openid realm (default is cgiurl)
  161. #openid_realm: ''
  162. # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
  163. #openid_cgiurl: ''
  164. # passwordauth plugin
  165. # a password that must be entered when signing up for an account
  166. #account_creation_password: s3cr1t
  167. # cost of generating a password using Authen::Passphrase::BlowfishCrypt
  168. #password_cost: 8
  169. ######################################################################
  170. # format plugins
  171. # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, textile, txt)
  172. ######################################################################
  173. # highlight plugin
  174. # types of source files to syntax highlight
  175. #tohighlight: .c .h .cpp .pl .py Makefile:make
  176. # location of highlight's filetypes.conf
  177. #filetypes_conf: /etc/highlight/filetypes.conf
  178. # location of highlight's langDefs directory
  179. #langdefdir: /usr/share/highlight/langDefs
  180. # mdwn plugin
  181. # enable multimarkdown features?
  182. #multimarkdown: 0
  183. # po plugin
  184. # master language (non-PO files)
  185. po_master_language: en|English
  186. # slave languages (translated via PO files) format: ll|Langname
  187. po_slave_languages:
  188. - de|Deutsch
  189. - fa|Farsi
  190. - fr|Français
  191. - it|Italiano
  192. - pt|Português
  193. # PageSpec controlling which pages are translatable
  194. #
  195. # On each release `n` of Tails 3.0, 4.0, etc. this list should be
  196. # updated to disable translations of news/version_*, news/test_*, and
  197. # security/Numerous_security_holes_in_* for release `n-2`.
  198. #
  199. # When updating this list, refer to the checklist in
  200. # https://tails.boum.org/contribute/how/website/po_translatable_pages/
  201. po_translatable_pages: '!security/audits and !security/audits/* and !news/report_2* and !news/version_0* and !news/test_0* and !news/test_*-rc? and !security/Numerous_security_holes_in_0* and (about or about/* or bugs or chat or contribute or contribute/how/donate or doc or doc/* or donate or donate/* or download or download.inline or getting_started or home or inc/stable_i386_release_notes or index or news or news/* or press or security or security/* or sidebar or support or support/* or todo or torrents or wishlist or misc or misc/* or install or install/* or upgrade or upgrade/*)'
  202. # internal linking behavior (default/current/negotiated)
  203. po_link_to: current
  204. ######################################################################
  205. # misc plugins
  206. # (filecheck)
  207. ######################################################################
  208. ######################################################################
  209. # web plugins
  210. # (404, attachment, comments, editdiff, edittemplate, getsource, google,
  211. # goto, mirrorlist, remove, rename, repolist, search, theme, websetup,
  212. # wmd)
  213. ######################################################################
  214. # attachment plugin
  215. # enhanced PageSpec specifying what attachments are allowed
  216. #allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
  217. # virus checker program (reads STDIN, returns nonzero if virus found)
  218. #virus_checker: clamdscan -
  219. # comments plugin
  220. # PageSpec of pages where comments are allowed
  221. #comments_pagespec: forum/*
  222. # PageSpec of pages where posting new comments is not allowed
  223. #comments_closed_pagespec: ''
  224. # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
  225. #comments_pagename: comment_
  226. # Interpret directives in comments?
  227. #comments_allowdirectives: 0
  228. # Allow anonymous commenters to set an author name?
  229. #comments_allowauthor: 0
  230. # commit comments to the VCS
  231. #comments_commit: 1
  232. # getsource plugin
  233. # Mime type for returned source.
  234. #getsource_mimetype: text/plain; charset=utf-8
  235. # mirrorlist plugin
  236. # list of mirrors
  237. mirrorlist:
  238. tails.boum.org: https://tails.boum.org/ikiwiki.cgi
  239. # generate links that point to the mirrors' ikiwiki CGI
  240. mirrorlist_use_cgi: 1
  241. # repolist plugin
  242. # URIs of repositories containing the wiki's source
  243. #repositories:
  244. # - svn://svn.example.org/wiki/trunk
  245. # search plugin
  246. # path to the omega cgi program
  247. #omega_cgi: /usr/lib/cgi-bin/omega/omega
  248. # theme plugin
  249. # name of theme to enable
  250. #theme: actiontabs
  251. # websetup plugin
  252. # list of plugins that cannot be enabled/disabled via the web interface
  253. #websetup_force_plugins: []
  254. # list of additional setup field keys to treat as unsafe
  255. #websetup_unsafe: []
  256. # show unsafe settings, read-only, in web interface?
  257. #websetup_show_unsafe: 1
  258. ######################################################################
  259. # widget plugins
  260. # (calendar, color, conditional, cutpaste, date, format, fortune,
  261. # graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
  262. # pagecount, pagestats, poll, polygen, postsparkline, progress,
  263. # shortcut, sparkline, table, template, teximg, toc, toggle, version)
  264. ######################################################################
  265. # calendar plugin
  266. # base of the archives hierarchy
  267. #archivebase: archives
  268. # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
  269. #archive_pagespec: page(posts/*) and !*/Discussion
  270. # listdirectives plugin
  271. # directory in srcdir that contains directive descriptions
  272. #directive_description_dir: ikiwiki/directive
  273. # teximg plugin
  274. # Should teximg use dvipng to render, or dvips and convert?
  275. #teximg_dvipng: ''
  276. # LaTeX prefix for teximg plugin
  277. #teximg_prefix: |
  278. # \documentclass{article}
  279. # \usepackage[utf8]{inputenc}
  280. # \usepackage{amsmath}
  281. # \usepackage{amsfonts}
  282. # \usepackage{amssymb}
  283. # \pagestyle{empty}
  284. # \begin{document}
  285. # LaTeX postfix for teximg plugin
  286. #teximg_postfix: '\end{document}'
  287. ######################################################################
  288. # other plugins
  289. # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
  290. # flattr, goodstuff, htmlbalance, localstyle, pagetemplate, pandoc,
  291. # pingee, pinger, prettydate, recentchanges, recentchangesdiff,
  292. # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
  293. # testpagespec, transient, underlay)
  294. ######################################################################
  295. # aggregate plugin
  296. # enable aggregation to internal pages?
  297. #aggregateinternal: 1
  298. # allow aggregation to be triggered via the web?
  299. #aggregate_webtrigger: 0
  300. # cookie control
  301. #cookiejar:
  302. # file: /home/user/.ikiwiki/cookies
  303. # autoindex plugin
  304. # commit autocreated index pages
  305. #autoindex_commit: 1
  306. # camelcase plugin
  307. # list of words to not turn into links
  308. #camelcase_ignore: []
  309. # flattr plugin
  310. # userid or user name to use by default for Flattr buttons
  311. #flattr_userid: joeyh
  312. # pandoc plugin
  313. # Path to pandoc executable
  314. #pandoc_command: /usr/bin/pandoc
  315. # File extension for Markdown files
  316. #pandoc_markdown_ext: mdwn
  317. # Enable Pandoc processing of LaTeX documents
  318. #pandoc_latex: 0
  319. # Enable Pandoc processing of reStructuredText documents
  320. #pandoc_rst: 0
  321. # Use smart quotes, dashes, and ellipses
  322. #pandoc_smart: 1
  323. # Output format (html, markdown or latex)
  324. #pandoc_output_format: html
  325. # Path depth of which LaTeX parts roots (e.g.: bla/part1 = depth 2)
  326. #pandoc_parts_at_depth: 1
  327. # Shift headers level depending on page depth (default: enabled for LaTeX output, disabled else)
  328. #pandoc_shift_headers: 1
  329. # pinger plugin
  330. # how many seconds to try pinging before timing out
  331. #pinger_timeout: 15
  332. # prettydate plugin
  333. # format to use to display date
  334. #prettydateformat: '%X, %B %o, %Y'
  335. # recentchanges plugin
  336. # name of the recentchanges page
  337. #recentchangespage: recentchanges
  338. # number of changes to track
  339. #recentchangesnum: 100
  340. # rsync plugin
  341. # command to run to sync updated pages
  342. #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
  343. # sidebar plugin
  344. # show sidebar page on all pages?
  345. #global_sidebars: 1
  346. # tag plugin
  347. # parent page tags are located under
  348. tagbase: tags
  349. # autocreate new tag pages?
  350. #tag_autocreate: 1
  351. # commit autocreated tag pages
  352. tag_autocreate_commit: 1
  353. # underlay plugin
  354. # extra underlay directories to add
  355. add_underlays:
  356. - /home/amnesia/Persistent/Tails/promotion-material