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