ikiwiki.setup

   1 # IkiWiki::Setup::Yaml - YAML formatted setup file
   2 #
   3 # Setup file for ikiwiki.
   4 #
   5 # Passing this to ikiwiki --setup will make ikiwiki generate
   6 # wrappers and build the wiki.
   7 #
   8 # Remember to re-run ikiwiki --setup any time you edit this file.
   9 #
  10 # name of the wiki
  11 wikiname: Nos oignons
  12 # contact email for wiki
  13 adminemail: contact@nos-oignons.net
  14 # users who are wiki admins
  15 adminuser: []
  16 # users who are banned from the wiki
  17 banned_users: []
  18 # where the source of the wiki is located
  19 srcdir: .
  20 # where to build the wiki
  21 destdir: ../dest
  22 # base url to the wiki
  23 url: ''
  24 # url to the ikiwiki.cgi
  25 cgiurl: ''
  26 # filename of cgi wrapper to generate
  27 cgi_wrapper: ''
  28 # mode for cgi_wrapper (can safely be made suid)
  29 cgi_wrappermode: '06755'
  30 # rcs backend to use
  31 rcs: git
  32 # plugins to add to the default configuration
  33 add_plugins:
  34 - html
  35 - img
  36 - po
  37 - recentchanges
  38 - sidebar
  39 # plugins to disable
  40 disable_plugins:
  41 - htmlscrubber
  42 # additional directory to search for template files
  43 templatedir: /usr/share/ikiwiki/templates
  44 # base wiki source location
  45 underlaydir: /usr/share/ikiwiki/basewiki
  46 # display verbose messages?
  47 #verbose: 1
  48 # log to syslog?
  49 #syslog: 1
  50 # create output files named page/index.html?
  51 usedirs: '1'
  52 # use '!'-prefixed preprocessor directives?
  53 prefix_directives: '1'
  54 # use page/index.mdwn source files
  55 indexpages: '0'
  56 # enable Discussion pages?
  57 discussion: '1'
  58 # name of Discussion pages
  59 discussionpage: Discussion
  60 # generate HTML5?
  61 html5: '0'
  62 # only send cookies over SSL connections?
  63 sslcookie: '0'
  64 # extension to use for new pages
  65 default_pageext: mdwn
  66 # extension to use for html files
  67 htmlext: html
  68 # strftime format string to display date
  69 timeformat: '%c'
  70 # UTF-8 locale to use
  71 locale: fr-FR.UTF-8
  72 # put user pages below specified page
  73 userdir: ''
  74 # how many backlinks to show before hiding excess (0 to show all)
  75 numbacklinks: '10'
  76 # attempt to hardlink source files? (optimisation for large files)
  77 hardlink: '0'
  78 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
  79 #umask: public
  80 # group for wrappers to run in
  81 #wrappergroup: ikiwiki
  82 # extra library and plugin directory
  83 libdir: ''
  84 # environment variables
  85 ENV: {}
  86 # time zone name
  87 #timezone: US/Eastern
  88 # regexp of normally excluded files to include
  89 #include: ^\.htaccess$
  90 # regexp of files that should be skipped
  91 #exclude: ^(*\.private|Makefile)$
  92 # specifies the characters that are allowed in source filenames
  93 wiki_file_chars: -[:alnum:]+/.:_
  94 # allow symlinks in the path leading to the srcdir (potentially insecure)
  95 allow_symlinks_before_srcdir: '0'
  96
  97 ######################################################################
  98 # core plugins
  99 #   (editpage, git, htmlscrubber, inline, link, meta, parentlinks)
 100 ######################################################################
 101
 102 # git plugin
 103 # git hook to generate
 104 #git_wrapper: /git/wiki.git/hooks/post-update
 105 # shell command for git_wrapper to run, in the background
 106 #git_wrapper_background_command: git push github
 107 # mode for git_wrapper (can safely be made suid)
 108 #git_wrappermode: '06755'
 109 # git pre-receive hook to generate
 110 #git_test_receive_wrapper: /git/wiki.git/hooks/pre-receive
 111 # unix users whose commits should be checked by the pre-receive hook
 112 #untrusted_committers: []
 113 # gitweb url to show file history ([[file]] substituted)
 114 #historyurl: http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]];hb=HEAD
 115 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
 116 #diffurl: http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]
 117 # where to pull and push changes (set to empty string to disable)
 118 gitorigin_branch: ''
 119 # branch that the wiki is stored in
 120 gitmaster_branch: master
 121
 122 # htmlscrubber plugin
 123 # PageSpec specifying pages not to scrub
 124 #htmlscrubber_skip: '!*/Discussion'
 125
 126 # inline plugin
 127 # enable rss feeds by default?
 128 #rss: 0
 129 # enable atom feeds by default?
 130 #atom: 0
 131 # allow rss feeds to be used?
 132 allowrss: '1'
 133 # allow atom feeds to be used?
 134 allowatom: '1'
 135 # urls to ping (using XML-RPC) on feed update
 136 pingurl: []
 137
 138 ######################################################################
 139 # auth plugins
 140 #   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
 141 #    opendiscussion, openid, passwordauth, signinedit)
 142 ######################################################################
 143
 144 # anonok plugin
 145 # PageSpec to limit which pages anonymous users can edit
 146 #anonok_pagespec: '*/discussion'
 147
 148 # blogspam plugin
 149 # PageSpec of pages to check for spam
 150 #blogspam_pagespec: postcomment(*)
 151 # options to send to blogspam server
 152 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
 153 # blogspam server XML-RPC url
 154 #blogspam_server: ''
 155
 156 # httpauth plugin
 157 # url to redirect to when authentication is needed
 158 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
 159 # PageSpec of pages where only httpauth will be used for authentication
 160 #httpauth_pagespec: '!*/Discussion'
 161
 162 # lockedit plugin
 163 # PageSpec controlling which pages are locked
 164 #locked_pages: '!*/Discussion'
 165
 166 # moderatedcomments plugin
 167 # PageSpec matching users or comment locations to moderate
 168 #moderate_pagespec: '*'
 169
 170 # openid plugin
 171 # url pattern of openid realm (default is cgiurl)
 172 #openid_realm: ''
 173 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 174 #openid_cgiurl: ''
 175
 176 # passwordauth plugin
 177 # a password that must be entered when signing up for an account
 178 #account_creation_password: s3cr1t
 179 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
 180 #password_cost: 8
 181
 182 ######################################################################
 183 # format plugins
 184 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
 185 #    txt)
 186 ######################################################################
 187
 188 # highlight plugin
 189 # types of source files to syntax highlight
 190 #tohighlight: .c .h .cpp .pl .py Makefile:make
 191 # location of highlight's filetypes.conf
 192 #filetypes_conf: /etc/highlight/filetypes.conf
 193 # location of highlight's langDefs directory
 194 #langdefdir: /usr/share/highlight/langDefs
 195
 196 # mdwn plugin
 197 # enable multimarkdown features?
 198 #multimarkdown: 0
 199 # disable use of markdown discount?
 200 #nodiscount: 0
 201
 202 # po plugin
 203 # master language (non-PO files)
 204 po_master_language: fr|French
 205 # slave languages (translated via PO files) format: ll|Langname
 206 po_slave_languages:
 207 - en|English
 208 # PageSpec controlling which pages are translatable
 209 po_translatable_pages: À_propos or Donnez or Contact
 210 # internal linking behavior (default/current/negotiated)
 211 po_link_to: default
 212
 213 ######################################################################
 214 # special-purpose plugins
 215 #   (osm)
 216 ######################################################################
 217
 218 # osm plugin
 219 # the default zoom when you click on the map link
 220 #osm_default_zoom: '15'
 221 # the icon shown on links and on the main map
 222 #osm_default_icon: ikiwiki/images/osm.png
 223 # the alt tag of links, defaults to empty
 224 #osm_alt: ''
 225 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
 226 #osm_format: KML
 227 # the icon attached to a tag, displayed on the map for tagged pages
 228 #osm_tag_default_icon: icon.png
 229
 230 ######################################################################
 231 # web plugins
 232 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
 233 #    goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
 234 #    websetup, wmd)
 235 ######################################################################
 236
 237 # attachment plugin
 238 # enhanced PageSpec specifying what attachments are allowed
 239 #allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
 240 # virus checker program (reads STDIN, returns nonzero if virus found)
 241 #virus_checker: clamdscan -
 242
 243 # comments plugin
 244 # PageSpec of pages where comments are allowed
 245 #comments_pagespec: blog/* and !*/Discussion
 246 # PageSpec of pages where posting new comments is not allowed
 247 #comments_closed_pagespec: blog/controversial or blog/flamewar
 248 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 249 #comments_pagename: ''
 250 # Interpret directives in comments?
 251 #comments_allowdirectives: 0
 252 # Allow anonymous commenters to set an author name?
 253 #comments_allowauthor: 0
 254 # commit comments to the VCS
 255 #comments_commit: 1
 256
 257 # getsource plugin
 258 # Mime type for returned source.
 259 #getsource_mimetype: text/plain; charset=utf-8
 260
 261 # mirrorlist plugin
 262 # list of mirrors
 263 #mirrorlist: {}
 264 # generate links that point to the mirrors' ikiwiki CGI
 265 #mirrorlist_use_cgi: 1
 266
 267 # repolist plugin
 268 # URIs of repositories containing the wiki's source
 269 #repositories:
 270 #- svn://svn.example.org/wiki/trunk
 271
 272 # search plugin
 273 # path to the omega cgi program
 274 #omega_cgi: /usr/lib/cgi-bin/omega/omega
 275
 276 # theme plugin
 277 # name of theme to enable
 278 #theme: actiontabs
 279
 280 # websetup plugin
 281 # list of plugins that cannot be enabled/disabled via the web interface
 282 #websetup_force_plugins: []
 283 # list of additional setup field keys to treat as unsafe
 284 #websetup_unsafe: []
 285 # show unsafe settings, read-only, in web interface?
 286 #websetup_show_unsafe: 1
 287
 288 ######################################################################
 289 # widget plugins
 290 #   (calendar, color, conditional, cutpaste, date, format, fortune,
 291 #    graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
 292 #    more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
 293 #    progress, shortcut, sparkline, table, template, teximg, toc, toggle,
 294 #    version)
 295 ######################################################################
 296
 297 # calendar plugin
 298 # base of the archives hierarchy
 299 #archivebase: archives
 300 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 301 #archive_pagespec: page(posts/*) and !*/Discussion
 302
 303 # listdirectives plugin
 304 # directory in srcdir that contains directive descriptions
 305 #directive_description_dir: ikiwiki/directive
 306
 307 # teximg plugin
 308 # Should teximg use dvipng to render, or dvips and convert?
 309 #teximg_dvipng: ''
 310 # LaTeX prefix for teximg plugin
 311 #teximg_prefix: '\documentclass{article}
 312 #
 313 #  \usepackage[utf8]{inputenc}
 314 #
 315 #  \usepackage{amsmath}
 316 #
 317 #  \usepackage{amsfonts}
 318 #
 319 #  \usepackage{amssymb}
 320 #
 321 #  \pagestyle{empty}
 322 #
 323 #  \begin{document}
 324 #
 325 #'
 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 #    filecheck, flattr, goodstuff, htmlbalance, localstyle, notifyemail,
 333 #    pagetemplate, pingee, pinger, prettydate, recentchanges,
 334 #    recentchangesdiff, relativedate, rsync, sidebar, smiley,
 335 #    sortnaturally, tag, testpagespec, trail, 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/lunar/.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 # pinger plugin
 360 # how many seconds to try pinging before timing out
 361 #pinger_timeout: 15
 362
 363 # prettydate plugin
 364 # format to use to display date
 365 #prettydateformat: '%X, %B %o, %Y'
 366
 367 # recentchanges plugin
 368 # name of the recentchanges page
 369 recentchangespage: recentchanges
 370 # number of changes to track
 371 recentchangesnum: '100'
 372
 373 # rsync plugin
 374 # command to run to sync updated pages
 375 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
 376
 377 # sidebar plugin
 378 # show sidebar page on all pages?
 379 #global_sidebars: 1
 380
 381 # tag plugin
 382 # parent page tags are located under
 383 #tagbase: tag
 384 # autocreate new tag pages?
 385 #tag_autocreate: 1
 386 # commit autocreated tag pages
 387 #tag_autocreate_commit: 1
 388
 389 # underlay plugin
 390 # extra underlay directories to add
 391 #add_underlays:
 392 #- /home/lunar/wiki.underlay