files/etc/ikiwiki/ikiwiki.setup/DEFAULT

   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: gluestick
  12 # contact email for wiki
  13 adminemail: root@iwikiserver00.office.fsf.org
  14 # users who are wiki admins
  15 adminuser:
  16 - admin
  17 # users who are banned from the wiki
  18 banned_users: []
  19 # where the source of the wiki is located
  20 srcdir: /root/gluestick
  21 # where to build the wiki
  22 destdir: /root/public_html/gluestick
  23 # base url to the wiki
  24 url: http://iwikiserver00.office.fsf.org/~root/gluestick
  25 # url to the ikiwiki.cgi
  26 cgiurl: http://iwikiserver00.office.fsf.org/~root/gluestick/ikiwiki.cgi
  27 # filename of cgi wrapper to generate
  28 cgi_wrapper: /root/public_html/gluestick/ikiwiki.cgi
  29 # mode for cgi_wrapper (can safely be made suid)
  30 cgi_wrappermode: 06755
  31 # number of seconds to delay CGI requests when overloaded
  32 cgi_overload_delay: ''
  33 # message to display when overloaded (may contain html)
  34 cgi_overload_message: ''
  35 # rcs backend to use
  36 rcs: git
  37 # plugins to add to the default configuration
  38 add_plugins:
  39 - goodstuff
  40 - websetup
  41 # plugins to disable
  42 disable_plugins: []
  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: en_US.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: /root/.ikiwiki
  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 # cookie control
  98 cookiejar:
  99   file: /root/.ikiwiki/cookies
 100
 101 ######################################################################
 102 # core plugins
 103 #   (editpage, git, htmlscrubber, inline, link, meta, parentlinks)
 104 ######################################################################
 105
 106 # git plugin
 107 # git hook to generate
 108 git_wrapper: /root/gluestick.git/hooks/post-update
 109 # shell command for git_wrapper to run, in the background
 110 #git_wrapper_background_command: git push github
 111 # mode for git_wrapper (can safely be made suid)
 112 #git_wrappermode: 06755
 113 # git pre-receive hook to generate
 114 #git_test_receive_wrapper: /git/wiki.git/hooks/pre-receive
 115 # unix users whose commits should be checked by the pre-receive hook
 116 #untrusted_committers: []
 117 # gitweb url to show file history ([[file]] substituted)
 118 #historyurl: http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]];hb=HEAD
 119 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
 120 #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]]
 121 # where to pull and push changes (set to empty string to disable)
 122 #gitorigin_branch: origin
 123 # branch that the wiki is stored in
 124 #gitmaster_branch: master
 125
 126 # htmlscrubber plugin
 127 # PageSpec specifying pages not to scrub
 128 #htmlscrubber_skip: '!*/Discussion'
 129
 130 # inline plugin
 131 # enable rss feeds by default?
 132 rss: 1
 133 # enable atom feeds by default?
 134 atom: 1
 135 # allow rss feeds to be used?
 136 #allowrss: 0
 137 # allow atom feeds to be used?
 138 #allowatom: 0
 139 # urls to ping (using XML-RPC) on feed update
 140 #pingurl: http://rpc.technorati.com/rpc/ping
 141
 142 ######################################################################
 143 # auth plugins
 144 #   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
 145 #    opendiscussion, openid, passwordauth, signinedit)
 146 ######################################################################
 147
 148 # anonok plugin
 149 # PageSpec to limit which pages anonymous users can edit
 150 #anonok_pagespec: '*/discussion'
 151
 152 # blogspam plugin
 153 # PageSpec of pages to check for spam
 154 #blogspam_pagespec: postcomment(*)
 155 # options to send to blogspam server
 156 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
 157 # blogspam server XML-RPC url
 158 #blogspam_server: ''
 159
 160 # httpauth plugin
 161 # url to redirect to when authentication is needed
 162 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
 163 # PageSpec of pages where only httpauth will be used for authentication
 164 #httpauth_pagespec: '!*/Discussion'
 165
 166 # lockedit plugin
 167 # PageSpec controlling which pages are locked
 168 #locked_pages: '!*/Discussion'
 169
 170 # moderatedcomments plugin
 171 # PageSpec matching users or comment locations to moderate
 172 #moderate_pagespec: '*'
 173
 174 # openid plugin
 175 # url pattern of openid realm (default is cgiurl)
 176 #openid_realm: ''
 177 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 178 #openid_cgiurl: ''
 179
 180 # passwordauth plugin
 181 # a password that must be entered when signing up for an account
 182 #account_creation_password: s3cr1t
 183 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
 184 #password_cost: 8
 185
 186 ######################################################################
 187 # format plugins
 188 #   (creole, highlight, hnb, html, mdwn, otl, rawhtml, textile, 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 ######################################################################
 206 # special-purpose plugins
 207 #   (osm, underlay)
 208 ######################################################################
 209
 210 # osm plugin
 211 # the default zoom when you click on the map link
 212 #osm_default_zoom: 15
 213 # the icon shown on links and on the main map
 214 #osm_default_icon: ikiwiki/images/osm.png
 215 # the alt tag of links, defaults to empty
 216 #osm_alt: ''
 217 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
 218 #osm_format: KML
 219 # the icon attached to a tag, displayed on the map for tagged pages
 220 #osm_tag_default_icon: icon.png
 221 # Url for the OpenLayers.js file
 222 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
 223 # Layers to use in the map. Can be either the 'OSM' string or a type option for Google maps (GoogleNormal, GoogleSatellite, GoogleHybrid or GooglePhysical). It can also be an arbitrary URL in a syntax acceptable for OpenLayers.Layer.OSM.url parameter.
 224 #osm_layers:
 225 #  OSM: GoogleSatellite
 226 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
 227 #osm_google_apikey: ''
 228
 229 # underlay plugin
 230 # extra underlay directories to add
 231 #add_underlays:
 232 #- /root/wiki.underlay
 233
 234 ######################################################################
 235 # web plugins
 236 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
 237 #    goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
 238 #    websetup, wmd)
 239 ######################################################################
 240
 241 # attachment plugin
 242 # enhanced PageSpec specifying what attachments are allowed
 243 #allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
 244 # virus checker program (reads STDIN, returns nonzero if virus found)
 245 #virus_checker: clamdscan -
 246
 247 # comments plugin
 248 # PageSpec of pages where comments are allowed
 249 #comments_pagespec: blog/* and !*/Discussion
 250 # PageSpec of pages where posting new comments is not allowed
 251 #comments_closed_pagespec: blog/controversial or blog/flamewar
 252 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 253 #comments_pagename: ''
 254 # Interpret directives in comments?
 255 #comments_allowdirectives: 0
 256 # Allow anonymous commenters to set an author name?
 257 #comments_allowauthor: 0
 258 # commit comments to the VCS
 259 #comments_commit: 1
 260 # Restrict formats for comments to (no restriction if empty)
 261 #comments_allowformats: mdwn txt
 262
 263 # getsource plugin
 264 # Mime type for returned source.
 265 #getsource_mimetype: text/plain; charset=utf-8
 266
 267 # mirrorlist plugin
 268 # list of mirrors
 269 #mirrorlist: {}
 270 # generate links that point to the mirrors' ikiwiki CGI
 271 #mirrorlist_use_cgi: 1
 272
 273 # repolist plugin
 274 # URIs of repositories containing the wiki's source
 275 #repositories:
 276 #- svn://svn.example.org/wiki/trunk
 277
 278 # search plugin
 279 # path to the omega cgi program
 280 #omega_cgi: /usr/lib/cgi-bin/omega/omega
 281
 282 # theme plugin
 283 # name of theme to enable
 284 #theme: actiontabs
 285
 286 # websetup plugin
 287 # list of plugins that cannot be enabled/disabled via the web interface
 288 #websetup_force_plugins: []
 289 # list of additional setup field keys to treat as unsafe
 290 #websetup_unsafe: []
 291 # show unsafe settings, read-only, in web interface?
 292 #websetup_show_unsafe: 1
 293
 294 ######################################################################
 295 # widget plugins
 296 #   (calendar, color, conditional, cutpaste, date, format, fortune,
 297 #    graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
 298 #    more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
 299 #    progress, shortcut, sparkline, table, template, teximg, toc, toggle,
 300 #    version)
 301 ######################################################################
 302
 303 # calendar plugin
 304 # base of the archives hierarchy
 305 #archivebase: archives
 306 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 307 #archive_pagespec: page(posts/*) and !*/Discussion
 308
 309 # listdirectives plugin
 310 # directory in srcdir that contains directive descriptions
 311 #directive_description_dir: ikiwiki/directive
 312
 313 # teximg plugin
 314 # Should teximg use dvipng to render, or dvips and convert?
 315 #teximg_dvipng: ''
 316 # LaTeX prefix for teximg plugin
 317 #teximg_prefix: '\documentclass{article}
 318 #
 319 #  \usepackage[utf8]{inputenc}
 320 #
 321 #  \usepackage{amsmath}
 322 #
 323 #  \usepackage{amsfonts}
 324 #
 325 #  \usepackage{amssymb}
 326 #
 327 #  \pagestyle{empty}
 328 #
 329 #  \begin{document}
 330 #
 331 #'
 332 # LaTeX postfix for teximg plugin
 333 #teximg_postfix: \end{document}
 334
 335 ######################################################################
 336 # other plugins
 337 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
 338 #    filecheck, flattr, goodstuff, htmlbalance, localstyle, notifyemail,
 339 #    pagetemplate, pingee, pinger, prettydate, recentchanges,
 340 #    recentchangesdiff, relativedate, rsync, sidebar, smiley,
 341 #    sortnaturally, tag, testpagespec, trail, transient)
 342 ######################################################################
 343
 344 # aggregate plugin
 345 # enable aggregation to internal pages?
 346 #aggregateinternal: 1
 347 # allow aggregation to be triggered via the web?
 348 #aggregate_webtrigger: 0
 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