path: root/ikiwiki.setup

#!/usr/bin/perl
# 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.

our $libdir;
our $webdir;
our $cgidir;
our $gitdir;
our $webhost;
our $githost;
our $gitrepo;
BEGIN {
    $libdir = $ENV{'PWD'} . '/perl';
    $webdir = 'build/html';
    $cgidir = 'build/cgi';
    $gitdir = 'build/git';
    $webhost = 'wiki.example.org';
    $githost = 'git.example.org';
    $gitrepo = 'wiki';
}

use IkiWiki::Setup::Standard {
    # name of the wiki
    wikiname => 'MyWiki',
    # contact email for wiki
    #adminemail => 'me@example.org',
    # users who are wiki admins
    adminuser => [],
    # users who are banned from the wiki
    banned_users => [],
    # where the source of the wiki is located
    srcdir => 'content',
    # where to build the wiki
    destdir => $webdir,
    # base url to the wiki
    url => 'http://' . $webhost . '/',
    # url to the ikiwiki.cgi
    cgiurl => 'http://' . $webhost . '/ikiwiki.cgi',
    # cgi wrapper to generate
    cgi_wrapper => $cgidir . '/ikiwiki.cgi',
    # mode for cgi_wrapper (can safely be made suid)
    cgi_wrappermode => '00755',
    # rcs backend to use
    rcs => 'git',
    # plugins to add to the default configuration
    add_plugins => [qw{
        }],
    # plugins to disable
    disable_plugins => [qw{
        }],
    # location of template files
    templatedir => 'templates',
    # base wiki source location
    underlaydir => 'basewiki',
    # display verbose messages when building?
    #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 => 1,
    # 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
    #umask => 022,
    # extra library and plugin directory
    libdir => $libdir,
    # environment variables
    ENV => {},
    # regexp of source files to ignore
    #exclude => '\\.wav$',
    # 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,

    # aggregate plugin
    # enable aggregation to internal pages?
    #aggregateinternal => 0,
    # allow aggregation to be triggered via the web?
    #aggregate_webtrigger => 0,

    # amazon_s3 plugin
    # public access key id
    #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
    # file holding secret key (must not be readable by others!)
    #amazon_s3_key_id => 's3_key',
    # globally unique name of bucket to store wiki in
    #amazon_s3_bucket => 'mywiki',
    # a prefix to prepend to each page name
    #amazon_s3_prefix => 'wiki/',
    # which S3 datacenter to use (leave blank for default)
    #amazon_s3_location => 'EU',
    # store each index file twice? (allows urls ending in "/index.html" and "/")
    #amazon_s3_dupindex => 0,

    # anonok plugin
    # PageSpec to limit which pages anonymous users can edit
    #anonok_pagespec => '*/discussion',

    # 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 -',

    # bzr plugin
    # bzr post-commit hook to generate
    #bzr_wrapper => '',
    # mode for bzr_wrapper (can safely be made suid)
    #bzr_wrappermode => '06755',
    # url to show file history, using loggerhead ([[file]] substituted)
    #historyurl => '',
    # url to view a diff, using loggerhead ([[file]] and [[r2]] substituted)
    #diffurl => 'http://example.org/revision?start_revid=[[r2]]#[[file]]-s',

    # calendar plugin
    # base of the archives hierarchy
    #archivebase => 'archives',

    # git plugin
    # git hook to generate
    git_wrapper => $gitdir . '/post-update-ikiwiki',
    # mode for git_wrapper (can safely be made suid)
    git_wrappermode => '06755',
    # gitweb url to show file history ([[file]] substituted)
    #historyurl => 'http://' . $githost . '/gitweb.cgi?p=' . $gitrepo . '.git;a=history;f=[[file]]', # ;hb=master
    # gitweb url to show a diff ([[sha1_to]], [[sha1_from]], [[sha1_parent]], and [[file]] substituted)
    #diffurl => 'http://' . $githost . '/gitweb.cgi?p=' . $gitrepo . '.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]',
    # where to pull and push changes (set to empty string to disable)
    #gitorigin_branch => 'samplewiki',
    # 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 => 0,
    # 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 => 'http://rpc.technorati.com/rpc/ping',

    # listdirectives plugin
    # directory in srcdir that contains directive descriptions
    #directive_description_dir => 'ikiwiki/directive',

    # lockedit plugin
    # PageSpec controlling which pages are locked
    #locked_pages => '!*/Discussion',

    # mdwn plugin
    # enable multimarkdown features?
    #multimarkdown => 0,

    # mercurial plugin
    # mercurial post-commit hook to generate
    #mercurial_wrapper => '',
    # mode for mercurial_wrapper (can safely be made suid)
    #mercurial_wrappermode => '06755',
    # url to hg serve'd repository, to show file history ([[file]] substituted)
    #historyurl => 'http://example.org:8000/log/tip/[[file]]',
    # url to hg serve'd repository, to show diff ([[file]] and [[r2]] substituted)
    #diffurl => 'http://localhost:8000/?fd=[[r2]];file=[[file]]',

    # mirrorlist plugin
    # list of mirrors
    #mirrorlist => {},

    # openid plugin
    # an url where users can signup for an OpenID
    #openidsignup => 'http://myopenid.com/',

    # 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,

    # 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,

    # search plugin
    # path to the omega cgi program
    #omega_cgi => '/usr/lib/cgi-bin/omega/omega',

    # svn plugin
    # subversion repository location
    #svnrepo => '/svn/wiki',
    # path inside repository where the wiki is located
    #svnpath => 'trunk',
    # svn post-commit hook to generate
    #svn_wrapper => '/svn/wikirepo/hooks/post-commit',
    # mode for svn_wrapper (can safely be made suid)
    #svn_wrappermode => '04755',
    # viewvc url to show file history ([[file]] substituted)
    #historyurl => 'http://svn.example.org/trunk/[[file]]',
    # viewvc url to show a diff ([[file]], [[r1]], and [[r2]] substituted)
    #diffurl => 'http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]',

    # tag plugin
    # parent page tags are located under
    #tagbase => 'tag',

    # teximg plugin
    # Should teximg use dvipng to render, or dvips and convert?
    #teximg_dvipng => '',
    # LaTeX prefix for teximg plugin
    #teximg_prefix => '\\documentclass{article}
    #\\usepackage{amsmath}
    #\\usepackage{amsfonts}
    #\\usepackage{amssymb}
    #\\pagestyle{empty}
    #\\begin{document}
    #',
    # LaTeX postfix for teximg plugin
    #teximg_postfix => '\\end{document}',

    # tla plugin
    # tla post-commit hook to generate
    #tla_wrapper => '',
    # mode for tla_wrapper (can safely be made suid)
    #tla_wrappermode => '06755',
    # url to show file history ([[file]] substituted)
    #historyurl => '',
    # url to show a diff ([[file]] and [[rev]] substituted)
    #diffurl => '',

    # typography plugin
    # Text::Typography attributes value
    #typographyattributes => '3',

    # websetup plugin
    # list of plugins that cannot be enabled/disabled via the web interface
    #websetup_force_plugins => [],
    # show unsafe settings, read-only, in web interface?
    #websetup_show_unsafe => 1,
}