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