wiki.setup

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