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