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