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