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