local.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: .
  22 # where to build the wiki
  23 destdir: _site
  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 - goodstuff
  37 - websetup
  38 - lockedit
  39 #- attachment
  40 #- textile
  41 #- search
  42 #- httpauth
  43 # plugins to disable
  44 disable_plugins: []
  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: 1
  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: en_US.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: /home/wikiuser/.ikiwiki
  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: /var/lib/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.greptilian.com/?p=wiki.git;a=history;f=[[file]]
 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: origin
 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: '1'
 132 # enable atom feeds by default?
 133 atom: '1'
 134 # allow rss feeds to be used?
 135 #allowrss: 0
 136 # allow atom feeds to be used?
 137 #allowatom: 0
 138 # urls to ping (using XML-RPC) on feed update
 139 #pingurl: http://rpc.technorati.com/rpc/ping
 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 locked_pages: '*'
 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, po, 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 # po plugin
 206 # master language (non-PO files)
 207 #po_master_language: en|English
 208 # slave languages (translated via PO files) format: ll|Langname
 209 #po_slave_languages:
 210 #- fr|Français
 211 #- es|Español
 212 #- de|Deutsch
 213 # PageSpec controlling which pages are translatable
 214 #po_translatable_pages: '* and !*/Discussion'
 215 # internal linking behavior (default/current/negotiated)
 216 #po_link_to: current
 217
 218 ######################################################################
 219 # misc plugins
 220 #   (filecheck)
 221 ######################################################################
 222
 223 ######################################################################
 224 # web plugins
 225 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
 226 #    goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
 227 #    websetup, wmd)
 228 ######################################################################
 229
 230 # attachment plugin
 231 # enhanced PageSpec specifying what attachments are allowed
 232 #allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
 233 # virus checker program (reads STDIN, returns nonzero if virus found)
 234 #virus_checker: clamdscan -
 235
 236 # comments plugin
 237 # PageSpec of pages where comments are allowed
 238 #comments_pagespec: blog/* and !*/Discussion
 239 # PageSpec of pages where posting new comments is not allowed
 240 #comments_closed_pagespec: blog/controversial or blog/flamewar
 241 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 242 #comments_pagename: ''
 243 # Interpret directives in comments?
 244 #comments_allowdirectives: 0
 245 # Allow anonymous commenters to set an author name?
 246 #comments_allowauthor: 0
 247 # commit comments to the VCS
 248 #comments_commit: 1
 249
 250 # getsource plugin
 251 # Mime type for returned source.
 252 #getsource_mimetype: text/plain; charset=utf-8
 253
 254 # mirrorlist plugin
 255 # list of mirrors
 256 #mirrorlist: {}
 257
 258 # repolist plugin
 259 # URIs of repositories containing the wiki's source
 260 #repositories:
 261 #- svn://svn.example.org/wiki/trunk
 262
 263 # search plugin
 264 # path to the omega cgi program
 265 #omega_cgi: /var/www/cgi-bin/omega
 266
 267 # theme plugin
 268 # name of theme to enable
 269 #theme: actiontabs
 270
 271 # websetup plugin
 272 # list of plugins that cannot be enabled/disabled via the web interface
 273 #websetup_force_plugins: []
 274 # list of additional setup field keys to treat as unsafe
 275 #websetup_unsafe: []
 276 # show unsafe settings, read-only, in web interface?
 277 #websetup_show_unsafe: 1
 278
 279 ######################################################################
 280 # widget plugins
 281 #   (calendar, color, conditional, cutpaste, date, format, fortune,
 282 #    graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
 283 #    more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
 284 #    progress, shortcut, sparkline, table, template, teximg, toc, toggle,
 285 #    version)
 286 ######################################################################
 287
 288 # calendar plugin
 289 # base of the archives hierarchy
 290 #archivebase: archives
 291 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 292 #archive_pagespec: page(posts/*) and !*/Discussion
 293
 294 # listdirectives plugin
 295 # directory in srcdir that contains directive descriptions
 296 #directive_description_dir: ikiwiki/directive
 297
 298 # teximg plugin
 299 # Should teximg use dvipng to render, or dvips and convert?
 300 #teximg_dvipng: ''
 301 # LaTeX prefix for teximg plugin
 302 #teximg_prefix: '\documentclass{article}
 303 #
 304 #  \usepackage[utf8]{inputenc}
 305 #
 306 #  \usepackage{amsmath}
 307 #
 308 #  \usepackage{amsfonts}
 309 #
 310 #  \usepackage{amssymb}
 311 #
 312 #  \pagestyle{empty}
 313 #
 314 #  \begin{document}
 315 #
 316 #'
 317 # LaTeX postfix for teximg plugin
 318 #teximg_postfix: \end{document}
 319
 320 ######################################################################
 321 # other plugins
 322 #   (aggregate, amazon_s3, autoindex, brokenlinks, camelcase, ddate, embed,
 323 #    favicon, flattr, goodstuff, htmlbalance, localstyle, pagetemplate,
 324 #    pingee, pinger, prettydate, recentchanges, recentchangesdiff,
 325 #    relativedate, rsync, sidebar, smiley, sortnaturally, tag,
 326 #    testpagespec, transient, underlay)
 327 ######################################################################
 328
 329 # aggregate plugin
 330 # enable aggregation to internal pages?
 331 #aggregateinternal: 1
 332 # allow aggregation to be triggered via the web?
 333 #aggregate_webtrigger: 0
 334 # cookie control
 335 #cookiejar:
 336 #  file: /home/wikiuser/.ikiwiki/cookies
 337
 338 # amazon_s3 plugin
 339 # public access key id
 340 #amazon_s3_key_id: XXXXXXXXXXXXXXXXXXXX
 341 # file holding secret key (must not be readable by others!)
 342 #amazon_s3_key_id: /home/wikiuser/.s3_key
 343 # globally unique name of bucket to store wiki in
 344 #amazon_s3_bucket: mywiki
 345 # a prefix to prepend to each page name
 346 #amazon_s3_prefix: wiki/
 347 # which S3 datacenter to use (leave blank for default)
 348 #amazon_s3_location: EU
 349 # store each index file twice? (allows urls ending in "/index.html" and "/")
 350 #amazon_s3_dupindex: 0
 351
 352 # autoindex plugin
 353 # commit autocreated index pages
 354 #autoindex_commit: 1
 355
 356 # camelcase plugin
 357 # list of words to not turn into links
 358 #camelcase_ignore: []
 359
 360 # flattr plugin
 361 # userid or user name to use by default for Flattr buttons
 362 #flattr_userid: joeyh
 363
 364 # pinger plugin
 365 # how many seconds to try pinging before timing out
 366 #pinger_timeout: 15
 367
 368 # prettydate plugin
 369 # format to use to display date
 370 #prettydateformat: '%X, %B %o, %Y'
 371
 372 # recentchanges plugin
 373 # name of the recentchanges page
 374 #recentchangespage: recentchanges
 375 # number of changes to track
 376 #recentchangesnum: 100
 377
 378 # rsync plugin
 379 # command to run to sync updated pages
 380 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
 381
 382 # sidebar plugin
 383 # show sidebar page on all pages?
 384 #global_sidebars: 1
 385
 386 # tag plugin
 387 # parent page tags are located under
 388 #tagbase: tag
 389 # autocreate new tag pages?
 390 #tag_autocreate: 1
 391 # commit autocreated tag pages
 392 #tag_autocreate_commit: 1
 393
 394 # underlay plugin
 395 # extra underlay directories to add
 396 #add_underlays:
 397 #- /home/wikiuser/wiki.underlay